Convidar um usuário para uma organização do Cloud Manager
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Convida um usuário para a organização do Cloud Manager que você especificar.
O usuário deve aceitar o convite para acessar a organização 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
POST /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
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. | 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:
| false |
Parâmetros do corpo da solicitação
Parâmetro do corpo | Tipo | necessidade | Descrição |
|---|---|---|---|
roles | array de strings | Obrigatório | 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 | Opcional | 24exclusivas -strings de dígitos hexadecimais que identificam as equipes para as quais você convida o usuário a participar. |
nome de usuário | string | Obrigatório | Endereço de e-mail do usuário convidado. Este é o endereço para o qual o Cloud Manager envia o convite. Se o usuário aceitar o convite, ele fará login no Cloud Manager com esse nome de usuário. |
Resposta
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
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites?pretty=true" \ 5 --data ' 6 { 7 "roles": [ 8 "ORG_MEMBER" 9 ], 10 "username": "wyatt.smith@example.com" 11 }'
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
201 Created 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 "createdAt": "2021-02-18T21:05:40Z", 3 "expiresAt": "2021-03-20T21:05:40Z", 4 "id": "{INVITATION-ID}", 5 "inviterUsername": "admin@example.com", 6 "orgId": "{ORG-ID}", 7 "orgName": "{ORG-NAME}", 8 "roles": [ 9 "ORG_MEMBER" 10 ], 11 "teamIds": [], 12 "username": "wyatt.smith@example.com" 13 }