Docs Home

/ /

Organizaciones

Docs Home

/ /

Organizaciones y equipos

Organizaciones

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Organizaciones y equipos

Organizaciones

Obtenga todas las invitaciones de la organización

Recupera todas las invitaciones pendientes para la organización especificada de Ops Manager.

Roles necesarios

Puede llamar a este punto final con éxito con el Organization User Admin role.

Resource

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/invites

Parámetros de la ruta de solicitud

Elemento de ruta	Tipo	Necesidad	Descripción
ORG-ID	string	Requerido	Cadena de dígitos hexadecimales 24única que identifica a la organización.

Parámetros de consulta de solicitud

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Nombre de usuario	string	Opcional	Dirección de correo electrónico del usuario invitado. Esta es la dirección a la que Ops Manager envió la invitación. Si se omite, Ops Manager devuelve todas las invitaciones pendientes.

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

El documento JSON de respuesta incluye una matriz de objetos. Cada objeto representa una invitación al proyecto Ops Manager.

Nombre	Tipo	Descripción
creadoEn	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando Ops Manager envió la invitación.
expira en	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando expira la invitación. Los usuarios tienen 30 días para aceptar una invitación a un proyecto de Ops Manager.
ID.	string	Cadena de dígitos hexadecimales 24única que identifica la invitación.
inviterUsername	string	Usuario de Ops Manager que invitó a nombre de usuario a la organización.
orgId	string	Cadena de dígitos hexadecimales 24única que identifica a la organización.
nombre_org	string	Nombre de la organización.
papeles	matriz de cadenas	Gerente de Operaciones Roles para asignar al usuario invitado. Si el usuario acepta la invitación, Ops Manager le asigna estos roles.
ID de equipo	matriz de cadenas	Cadenas de dígitos hexadecimales 24únicas que identifican los equipos a los que el usuario fue invitado a unirse.
Nombre de usuario	string	Dirección de correo electrónico a la que Ops Manager envió la invitación. Si el usuario acepta la invitación, utilizará esta dirección de correo electrónico como su nombre de usuario de Ops Manager.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://opsmanager.example.com/api/public/v1.0/orgs/{ORG-ID}/invites?pretty=true"

Ejemplo de respuesta

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Cuerpo de respuesta

1 [
2   {
3     "createdAt": "2021-02-18T18:51:46Z",
4     "expiresAt": "2021-03-20T18:51:46Z",
5     "id": "{INVITATION-ID-1}",
6     "inviterUsername": "admin@example.com",
7     "orgId": "{ORG-ID}",
8     "orgName": "{ORG-NAME}",
9     "roles": [
10       "GROUP_OWNER"
11     ],
12     "teamIds": [],
13     "username": "jane.smith@example.com"
14   },
15   {
16     "createdAt": "2021-02-18T21:28:38Z",
17     "expiresAt": "2021-03-20T21:28:38Z",
18     "id": "{INVITATION-ID-2}",
19     "inviterUsername": "admin@example.com",
20     "orgId": "{ORG-ID}",
21     "orgName": "{ORG-NAME}",
22     "roles": [
23       "ORG_MEMBER"
24     ],
25     "teamIds": [],
26     "username": "john.smith@example.com"
27   },
28   {
29     "createdAt": "2021-02-18T21:05:40Z",
30     "expiresAt": "2021-03-20T21:05:40Z",
31     "id": "{INVITATION-ID-3}",
32     "inviterUsername": "admin@example.com",
33     "orgId": "{ORG-ID}",
34     "orgName": "{ORG-NAME}",
35     "roles": [
36       "ORG_MEMBER"
37     ],
38     "teamIds": [],
39     "username": "wyatt.smith@example.com"
40   }
41 ]

Volver

Borrar invitación

Obtenga una invitación

1	[
2	{
3	"createdAt": "2021-02-18T18:51:46Z",
4	"expiresAt": "2021-03-20T18:51:46Z",
5	"id": "{INVITATION-ID-1}",
6	"inviterUsername": "admin@example.com",
7	"orgId": "{ORG-ID}",
8	"orgName": "{ORG-NAME}",
9	"roles": [
10	"GROUP_OWNER"
11	],
12	"teamIds": [],
13	"username": "jane.smith@example.com"
14	},
15	{
16	"createdAt": "2021-02-18T21:28:38Z",
17	"expiresAt": "2021-03-20T21:28:38Z",
18	"id": "{INVITATION-ID-2}",
19	"inviterUsername": "admin@example.com",
20	"orgId": "{ORG-ID}",
21	"orgName": "{ORG-NAME}",
22	"roles": [
23	"ORG_MEMBER"
24	],
25	"teamIds": [],
26	"username": "john.smith@example.com"
27	},
28	{
29	"createdAt": "2021-02-18T21:05:40Z",
30	"expiresAt": "2021-03-20T21:05:40Z",
31	"id": "{INVITATION-ID-3}",
32	"inviterUsername": "admin@example.com",
33	"orgId": "{ORG-ID}",
34	"orgName": "{ORG-NAME}",
35	"roles": [
36	"ORG_MEMBER"
37	],
38	"teamIds": [],
39	"username": "wyatt.smith@example.com"
40	}
41	]