Página inicial do Docs

/ /

Projetos

Página inicial do Docs

/ /

Projetos e usuários

Projetos

Página inicial do Docs

Obter um convite de projeto

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

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

Funções obrigatórias

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

Resource

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

GET /groups/{GROUP-ID}/invites/{INVITATION-ID}

Parâmetros do caminho da solicitação

Elemento do caminho	Tipo	necessidade	Descrição
ID do grupo	string	Obrigatório	String única de 24 dígitos hexadecimais que identifica o projeto.
ID DE CLIQUE	string	Obrigatório	String exclusiva de 24 dígitos hexadecimais que identifica o convite.

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 de impressão bonita.

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

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Nome	Tipo	Descrição
createdAt	string	Registro de data/hora no formato de data e hora ISO 8601 em UTC quando o Cloud Manager 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 Cloud 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 Cloud Manager que Convidou o nome de usuário para o projeto.
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.
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/groups/{GROUP-ID}/invites/{INVITATIO-ID}?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   "createdAt": "2021-02-18T18:51:46Z",
3   "expiresAt": "2021-03-20T18:51:46Z",
4   "groupId": "{GROUP-ID}",
5   "groupName": "group",
6   "id": "{INVITATION-ID}",
7   "inviterUsername": "admin@example.com",
8   "roles": [
9     "GROUP_OWNER"
10   ],
11   "username": "jane.smith@example.com"
12 }

Voltar

Obter todos os convites

Atualizar convite por ID de convite

1	{
2	"createdAt": "2021-02-18T18:51:46Z",
3	"expiresAt": "2021-03-20T18:51:46Z",
4	"groupId": "{GROUP-ID}",
5	"groupName": "group",
6	"id": "{INVITATION-ID}",
7	"inviterUsername": "admin@example.com",
8	"roles": [
9	"GROUP_OWNER"
10	],
11	"username": "jane.smith@example.com"
12	}