Recupera todos os convites pendentes para o projeto especificado do Cloud Manager.
Funções obrigatórias
Você pode chamar esse endpoint com sucesso com a função Project User Admin .
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{GROUP-ID}/invites
Parâmetros do caminho da solicitação
Elemento do caminho | Tipo | necessidade | Descrição |
|---|---|---|---|
ID do grupo | string | Obrigatório | String única de 24 dígitos hexadecimais que identifica o projeto. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta deve estar em um formato prettyprint. |
| ||||||
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
nome de usuário | string | Opcional | Endereço de e-mail do usuário convidado. Este é o endereço para o qual o Cloud Manager enviou o convite. Se omitido, o Cloud Manager retorna todos os convites pendentes. |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
O documento JSON de resposta inclui uma array de objetos. Cada objeto representa um convite para o projeto do Cloud Manager.
Nome | Tipo | Descrição |
|---|---|---|
createdAt | string | Timestamp in ISO 8601 date and time format in UTC when Cloud Manager sent the invitation. |
expiresAt | string | Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Os usuários têm 30 dias para aceitar um convite para um projeto do Cloud Manager. |
groupId | string | String única de 24 dígitos hexadecimais que identifica o projeto. |
groupName | string | Nome do projeto. |
id | string | String exclusiva de 24 dígitos hexadecimais que identifica o convite. |
InvitationrUsername | string | Usuário do Cloud Manager que Convidou o nome de usuário para o projeto. |
roles | array de strings | Funções do Cloud Manager a serem atribuídas ao usuário convidado. Se o usuário aceitar o convite, o Cloud Manager atribuirá essas funções a ele. |
nome de usuário | string | Endereço de e-mail para o qual o Cloud Manager enviou o convite. Se o usuário aceitar o convite, ele usará esse endereço de e-mail como seu nome de usuário do Cloud Manager. |
Exemplo de solicitação
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"
Exemplo de resposta
Cabeçalho de resposta
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
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}
Corpo de resposta
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 ]