Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/ / / /

Modificar detalhes de uma conta de serviço de projeto

Nesta página

  • 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

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

PATCH /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}
Nome
Tipo
Descrição

PROJECT-ID

string

Identificador exclusivo do projeto cuja conta de serviço você deseja atualizar. Use o endpoint /groups para extrair todos os projetos aos 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 o projeto especificado.

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

false

envelope

booleano

Indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure "envelope" : true na consulta.

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

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

O parâmetro do corpo é obrigatório.

Nome
Tipo
necessidade
Descrição

name

string

Opcional

Nome da conta de serviço. Os caracteres aceitos são A-Z, a-z, 0-9, espaço, ponto ., apóstrofo ', vírgula ,, sublinhado _ e traço -.

description

string

Opcional

Descrição da conta de serviço. Os caracteres aceitos são A-Z, a-z, 0-9, espaço, ponto ., apóstrofo ', vírgula ,, sublinhado _ e traço -.

roles

array de strings

Obrigatório

Lista de roles que a conta de serviço deve receber. No mínimo, uma função deve ser fornecida. Quaisquer funções fornecidas devem ser válidas para o projeto atribuído:

Valor da função na API
Função

GROUP_AUTOMATION_ADMIN

GROUP_BACKUP_ADMIN

GROUP_BILLING_ADMIN

Administrador de faturamento do projeto

GROUP_DATA_ACCESS_ADMIN

GROUP_DATA_ACCESS_READ_ONLY

GROUP_DATA_ACCESS_READ_WRITE

GROUP_MONITORING_ADMIN

GROUP_OWNER

GROUP_READ_ONLY

GROUP_USER_ADMIN

Inclua todos os roles que você deseja que essa conta de serviço tenha. Quaisquer funções que não estejam nesta array são removidas.

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

Lista de roles que a conta de serviço tem no projeto.

As funções do projeto incluem:

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.

Observação

O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}.

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \
6 --data '{
7 "roles": [ "GROUP_OWNER" ]
8 }'
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}
1{
2 "createdAt" : "2024-08-04T01:16:21Z",
3 "description" : "Service account for Cloud Manager users.",
4 "clientId" : "mdb_sa_id_66aed6653e07126244a84cc1",
5 "name" : "Cloud Manager service account",
6 "roles" : [ "GROUP_OWNER" ],
7 "secrets" : [ {
8 "createdAt" : "2024-08-04T01:16:21Z",
9 "expiresAt" : "2024-11-02T01:16:21Z",
10 "lastUsedAt" : "2024-08-24T21:10:35Z",
11 "id" : "66aed6653e07126244a84cc0",
12 "maskedSecretValue" : "mdb_sa_sk_...MeyM"
13 } ]
14}

Voltar

Atribuir