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.

Atribuir uma conta de serviço da organização ao projeto

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

Resource

POST /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}:invite

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

PROJECT-ID

string

Identificador exclusivo do projeto cujas contas de serviço você deseja atualizar. Use o endpoint /groups para recuperar todas as organizações às quais o usuário autenticado tem acesso.

CLIENT-ID

string

Identificador exclusivo da conta de serviço que você deseja atualizar. Solicite o endpoint /groups/{PROJECT-ID}/serviceAccounts para recuperar todas as contas de serviço às quais o usuário autenticado tem acesso para a organização especificada.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
Descrição
Default

pageNum

inteiro

Número da página (com base em índice 1).

1

itemsPerPage

inteiro

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Indica se o corpo da resposta deve ser retornado em um formato prettyprint.

false

envelope

booleano

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, configure "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

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

none

Parâmetros do corpo da solicitação

Nome
Tipo
necessidade
Descrição

roles

array

Obrigatório

Lista de funções a serem concedidas à conta de serviço. Deve ser fornecida pelo menos uma função. As funções fornecidas devem ser válidas para o projeto atribuído:

Resposta

Elementos de resposta

Se você definir o elemento de query envelope como true, a resposta será envolvida pelo objeto content .

A resposta HTTP retorna um JSON document que inclui os seguintes objeto:

Nome
Tipo
Descrição

clientId

string

Identificador exclusivo da conta de serviço.

createdAt

timestamp

Hora de criação da conta de serviço.

name

string

Nome da conta de serviço.

description

string

Descrição da conta de serviço.

roles

array de strings

secrets

array de objetos

Lista de segredos de conta de serviço.

secrets.id

string

24-string exclusivo de caracteres hexadecimais que identifica o segredo.

secrets.createdAt

timestamp

Timestamp representando o tempo de criação do segredo.

secrets.expiresAt

timestamp

Timestamp representando o tempo de expiração secreto.

secrets.lastUsedAt

timestamp

Registro de data/hora representando o último uso secreto.

secrets.maskedSecretValue

string

Segredo oculto que exibe apenas o prefixo e os últimos quatro caracteres.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --header "Content-Type: application/json" \     --include \     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}:invite?pretty=true" \     --data '{       "roles": [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ]     }'

Exemplo de resposta

Cabeçalho de resposta

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 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

{  "createdAt" : "2024-08-03T14:02:40Z",  "description" : "Service account for developers.",  "clientId" : "mdb_sa_id_66ae38803cdf55582cb01144",  "name" : "Dev Service Account",  "roles" : [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ],  "secrets" : [ {    "createdAt" : "2024-08-03T14:02:40Z",    "expiresAt" : "2024-12-31T14:02:40Z",    "id" : "66ae38803cdf55582cb01143",    "lastUsedAt" : "2024-08-24T21:10:35Z",    "maskedSecretValue" : "mdb_sa_sk_...hcOL"  } ]}
Avalie esta página

Nesta página