Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Organizações e equipes
/
Organizações

Obter todos os convites da organização

Nesta página

  • Funções obrigatórias
  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

Recupera todos os convites pendentes para a organização especificada do Cloud Manager.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com o role Organization User Admin .

Resource

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

GET /orgs/{ORG-ID}/invites

Parâmetros do caminho da solicitação

Elemento do caminho
Tipo
necessidade
Descrição
ORG-ID
string
Obrigatório
String única de 24 dígitos hexadecimais que identifica a organização.

Solicitar parâmetros de query

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
false
envelope
booleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da 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
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado
false
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
Carimbo de data/hora na ISO 8601 formato de data e hora no UTC quando o Cloud Manager enviou o convite.
expiresAt
string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando o convite expira.

Os usuários têm 30 dias para aceitar um convite para um projeto do Cloud Manager.

id
string
String exclusiva de 24 dígitos hexadecimais que identifica o convite.
InvitationrUsername
string
Usuário do Cloud Manager que chamou o username para a organização.
orgId
string
String única de 24 dígitos hexadecimais que identifica a organização.
orgName
string
Nome da organização.
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.

teamIds
array de strings
Sequências exclusivas de 24 dígitos hexadecimais que identificam as equipes para as quais o usuário foi convidado a participar.
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/orgs/{ORG-ID}/invites?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

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]

Voltar

Excluir convite

Próximo

Obter um convite