Convidar um usuário do MongoDB Cloud para uma organização Atlas
Convida um usuário do MongoDB Cloud para participar da organização especificada. O usuário deve aceitar o convite para acessar informações dentro da organização especificada. Para usar este recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário da organização.
parâmetros de caminho
-
String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
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 consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Convida um usuário do MongoDB Cloud para participar da organização especificada.
-
Lista de projetos aos quais o usuário será adicionado quando aceitar o convite para a organização.
-
Uma ou mais funções no nível da organização a serem atribuídas ao usuário do MongoDB Cloud.
Os valores são
ORG_OWNER,ORG_MEMBER,ORG_GROUP_CREATOR,ORG_BILLING_ADMIN,ORG_BILLING_READ_ONLY,ORG_STREAM_PROCESSING_ADMINouORG_READ_ONLY. -
Lista de equipes para as quais você deseja convidar o usuário desejado da MongoDB Cloud.
-
Endereço de e-mail que pertence ao usuário desejado do MongoDB Cloud.
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/invites' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"groupRoleAssignments":[{"groupId":"32b6e34b3d91647abb20e7b8","roles":["GROUP_BACKUP_MANAGER"]}],"roles":["ORG_OWNER"],"teamIds":["string"],"username":"hello@example.com"}'{
"groupRoleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"roles": [
"GROUP_BACKUP_MANAGER"
]
}
],
"roles": [
"ORG_OWNER"
],
"teamIds": [
"string"
],
"username": "hello@example.com"
}{
"createdAt": "2025-05-04T09:42:00Z",
"expiresAt": "2025-05-04T09:42:00Z",
"groupRoleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"groupRole": "GROUP_BACKUP_MANAGER"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "hello@example.com",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "string",
"roles": [
"ORG_OWNER"
],
"teamIds": [
"string"
],
"username": "hello@example.com"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}