/ /

/ /

Obtenga todas las invitaciones al proyecto

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Recupera todas las invitaciones pendientes para el proyecto de Cloud Manager especificado.

Roles necesarios

Puede llamar exitosamente a este endpoint con la Project User Admin role.

Resource

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

GET /groups/{GROUP-ID}/invites

Parámetros de la 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 señala si el cuerpo de respuesta debe estar en un prettyprint formato.

false

envelope

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 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 JSON de respuesta incluye una matriz 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 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 le 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 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     "groupId": "{GROUP-ID}",
6     "groupName": "group",
7     "id": "{INVITATION-ID}",
8     "inviterUsername": "admin@example.com",
9     "roles": [
10       "GROUP_OWNER"
11     ],
12     "username": "jane.smith@example.com"
13   },
14   {
15     "createdAt": "2021-02-18T21:05:40Z",
16     "expiresAt": "2021-03-20T21:05:40Z",
17     "groupId": "{GROUP-ID}",
18     "groupName": "group",
19     "id": "{INVITATION-ID}",
20     "inviterUsername": "admin@example.com",
21     "roles": [
22       "GROUP_READ_ONLY"
23     ],
24     "username": "john.smith@example.com"
25   }
26 ]

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	"groupId": "{GROUP-ID}",
6	"groupName": "group",
7	"id": "{INVITATION-ID}",
8	"inviterUsername": "admin@example.com",
9	"roles": [
10	"GROUP_OWNER"
11	],
12	"username": "jane.smith@example.com"
13	},
14	{
15	"createdAt": "2021-02-18T21:05:40Z",
16	"expiresAt": "2021-03-20T21:05:40Z",
17	"groupId": "{GROUP-ID}",
18	"groupName": "group",
19	"id": "{INVITATION-ID}",
20	"inviterUsername": "admin@example.com",
21	"roles": [
22	"GROUP_READ_ONLY"
23	],
24	"username": "john.smith@example.com"
25	}
26	]