Página inicial do Docs

/ /

Projetos

Página inicial do Docs

/ /

Projetos e usuários

Projetos

Página inicial do Docs

Atualizar um convite de projeto por ID de convite

Atualiza um convite pendente até {INVITATION-ID} para o projeto do Cloud Manager que você especifica.

Use o ponto de extremidade Get All Project Invitations para recuperar ID de todos os convites de projeto pendentes.

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

PATCH /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 prettyprint.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não 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:

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.

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	Timestamp in ISO 8601 date and time format in UTC when the invitation expires. 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        }'

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 um convite

Atualizar convite

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	}'

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	}