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 a função Organization User Admin .
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
POST /orgs/{ORG-ID}/invitesParâ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 que indica se o corpo da resposta deve estar em um formato prettyprint. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve 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:
|
|
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 | Timestamp in ISO 8601 date and time format in UTC when Cloud Manager sent the invitation. |
expiresAt | string | Registro de data/hora no formato de data e hora ISO 8601 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" \ --header "Content-Type: application/json" \ --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites?pretty=true" \ --data ' { "roles": [ "ORG_MEMBER" ], "username": "wyatt.smith@example.com" }'Exemplo de resposta
Cabeçalho de resposta
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 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
{ "createdAt": "2021-02-18T21:05:40Z", "expiresAt": "2021-03-20T21:05:40Z", "id": "{INVITATION-ID}", "inviterUsername": "admin@example.com", "orgId": "{ORG-ID}", "orgName": "{ORG-NAME}", "roles": [ "ORG_MEMBER" ], "teamIds": [], "username": "wyatt.smith@example.com"}