Docs Home

/ /

Organizaciones

Docs Home

/ /

Organizaciones y equipos

Organizaciones y equipos

Organizaciones

Obtener todas las invitaciones de organización

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

Roles necesarios

Puedes llamar a este endpoint con éxito si tienes el rol Organization User Admin.

Resource

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /orgs/{ORG-ID}/invites

Parámetros de ruta de solicitud

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

Parámetros de Solicitud Query

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

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

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

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

Nombre	Descripción
`status`	Código de respuesta HTTP
`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 Cloud Manager envió la invitación.

Si se omite, Cloud Manager devuelve todas las invitaciones pendientes.

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

El documento de respuesta JSON incluye un arreglo de objetos. Cada objeto representa una invitación al proyecto Cloud Manager.

Nombre	Tipo	Descripción
creado a las	string	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando Cloud Manager envió la invitación.
expira en	string	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando la invitación vence. Los usuarios tienen 30 días para aceptar una invitación a un proyecto de Cloud Manager.
ID	string	string única de 24 dígitos hexadecimales que identifica la invitación.
inviterUsername	string	Usuario de Cloud Manager que invitó a nombre de usuario a la organización.
orgId	string	string única de 24 dígitos hexadecimales que identifica a la organización.
orgName	string	Nombre de la organización.
Roles	Arreglo de cadenas	Cloud Manager roles para asignar al usuario invitado. Si el usuario acepta la invitación, Cloud Manager les asigna estos roles.
teamIds	Arreglo de cadenas	Cadenas únicas de 24 dígitos hexadecimales que identifican a los equipos a los que se invitó al usuario a unirse.
Nombre de usuario	string	Dirección de correo electrónico a la que Cloud Manager envió la invitación. Si el usuario acepta la invitación, utiliza esta dirección de correo electrónico como su nombre de usuario de Cloud Manager.

Solicitud de ejemplo

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

Respuesta de ejemplo

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}

Respuesta del cuerpo

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

Consigue 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	]