Recupera todas las invitaciones pendientes para el proyecto de Cloud Manager especificado.
Roles necesarios
Puede llamar con éxito a este endpoint con el rol de Project User Admin.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{GROUP-ID}/invitesParámetros de ruta de solicitud
Elemento de ruta | Tipo | Necesidad | Descripción |
|---|---|---|---|
ID del grupo | string | Requerido | string única de 24 dÃgitos hexadecimales que identifica el Proyecto. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si se debe devolver el cuerpo de la respuesta en un prettyprint formato. |
|
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, establezca envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
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 formato de fecha y hora ISO 8601 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 caduca. Los usuarios tienen 30 dÃas para aceptar una invitación a un proyecto de Cloud Manager. |
ID del grupo | string | string única de 24 dÃgitos hexadecimales que identifica el Proyecto. |
groupName | string | Nombre del proyecto. |
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 al proyecto. |
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. |
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/groups/{GROUP-ID}/invites?pretty=true"Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
[ { "createdAt": "2021-02-18T18:51:46Z", "expiresAt": "2021-03-20T18:51:46Z", "groupId": "{GROUP-ID}", "groupName": "group", "id": "{INVITATION-ID}", "inviterUsername": "admin@example.com", "roles": [ "GROUP_OWNER" ], "username": "jane.smith@example.com" }, { "createdAt": "2021-02-18T21:05:40Z", "expiresAt": "2021-03-20T21:05:40Z", "groupId": "{GROUP-ID}", "groupName": "group", "id": "{INVITATION-ID}", "inviterUsername": "admin@example.com", "roles": [ "GROUP_READ_ONLY" ], "username": "john.smith@example.com" }]