Atualizar um convite de projeto por ID de convite
Atualiza as informações de um convite pendente para o projeto especificado. Para especificar o convite a ser atualizado, forneça a string de identificação exclusiva desse convite. Use o ponto de extremidade "Retornar todos os convites do projeto" para recuperar IDs de todos os convites de projetos pendentes. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.
parâmetros de caminho
-
Sequência única 24de dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$
. -
String exclusiva de 24 dígitos hexadecimais que identifica o convite.
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
.
corpo, corpo
Obrigatório
Atualiza as informações de um convite pendente para o projeto especificado.
-
Uma ou mais funções de nível do projeto a serem atribuídas ao usuário do MongoDB Cloud.
Os valores são
GROUP_BACKUP_MANAGER
,GROUP_CLUSTER_MANAGER
,GROUP_DATA_ACCESS_ADMIN
,GROUP_DATA_ACCESS_READ_ONLY
,GROUP_DATA_ACCESS_READ_WRITE
,GROUP_DATABASE_ACCESS_ADMIN
,GROUP_OBSERVABILITY_VIEWER
,GROUP_OWNER
,GROUP_READ_ONLY
,GROUP_SEARCH_INDEX_EDITOR
ouGROUP_STREAM_PROCESSING_OWNER
.
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/invites/{invitationId}' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"roles":["GROUP_BACKUP_MANAGER"]}'
{
"roles": [
"GROUP_BACKUP_MANAGER"
]
}
{
"createdAt": "2025-05-04T09:42:00Z",
"expiresAt": "2025-05-04T09:42:00Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"groupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"inviterUsername": "hello@example.com",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"roles": [
"GROUP_BACKUP_MANAGER"
],
"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"
}