Atualizar um convite de projeto

Nesta página

Funções obrigatórias

Resource
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

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.

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 .

Atualiza um convite pendente para o projeto do Cloud Manager que você especifica.

Funções obrigatórias

Você pode chamar esse endpoint com sucesso com o role Project User Admin .

Resource

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

PATCH /groups/{GROUP-ID}/invites

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.

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:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

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. IMPORTANTE: o Cloud Manager substitui as funções no convite pelas funções que você fornece nesta solicitação. Certifique-se de incluir todas as funções que deseja atribuir ao usuário nesta solicitação.
nome de usuário	string	Obrigatório	Nome de usuário do usuário cujo convite você deseja atualizar. No Cloud Manager, o nome de usuário de um usuário convidado é o endereço de e-mail para o qual o Cloud Manager enviou o convite.

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.
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

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invites/{INVITATION-ID}?pretty=true" \
5      --data '
6        {
7          "roles": [
8            "GROUP_OWNER"
9          ],
10          "username": "jane.smith@example.com"
11        }'

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

Atualizar convite por ID de convite

Obtenha todas as equipes

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/invites/{INVITATION-ID}?pretty=true" \
5	--data '
6	{
7	"roles": [
8	"GROUP_OWNER"
9	],
10	"username": "jane.smith@example.com"
11	}'

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	}