Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Criar um convite de projeto

Recupere os detalhes de um convite pendente para o projeto do Ops Manager especificado.

Se estiver ativado, o MongoDB Atlas adicionará o usuário ao projeto imediatamente e não retornará um convite para esse Bypass Invitation Mode usuário.

Você pode chamar esse endpoint com sucesso com a função Project User Admin .

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /groups/{GROUP-ID}/invites/
Elemento do caminho
Tipo
necessidade
Descrição

ID do grupo

string

Obrigatório

String única de 24 dígitos hexadecimais que identifica o projeto.

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 está em um formato pretty-print.

false

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:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

false

Nome
Tipo
Descrição

roles

array de strings

Lista de funções de projeto do Ops Manager a serem atribuídas ao usuário convidado. Se o usuário aceitar o convite, o gerente de operações atribuirá essas funções a ele. Especifique um ou mais dos seguintes valores:

nome de usuário

string

Endereço de e-mail para o qual o Ops Manager enviou o convite. O usuário usa esse endereço de e-mail como nome de usuário do Ops Manager se aceitar este convite.

Nome
Tipo
Descrição

createdAt

string

Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o gerente de operações enviou o convite.

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 Ops 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 Ops Manager que enviou o nome de usuário para o projeto.

roles

array de strings

Funções do Ops Manager a serem atribuídas ao usuário convidado.

Se o usuário aceitar o convite, o Ops Manager atribuirá essas funções a ele.

nome de usuário

string

Endereço de e-mail para o qual o Ops 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 Ops Manager.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request POST "https://opsmanager.example.com/api/public/v1.0/groups/{GROUP-ID}/invites?pretty=true" \ --data ' { "roles": [ "GROUP_OWNER" ], "username": "jane.doe@example.com" }'
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-alive
HTTP/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}
{ "createdAt": "2021-02-18T18:51:46Z", "expiresAt": "2021-03-20T18:51:46Z", "groupId": "{GROUP-ID}", "groupName": "group", "id": "{INVITATION-ID}", "inviterUsername": "admin@example.com", "roles": [ "GROUP_OWNER" ], "username": "jane.smith@example.com"}