Modificar detalhes de uma conta de serviço de projeto

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

Resource

PATCH /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}

Parâmetros do caminho da solicitação

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.

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

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 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: `GROUP_AUTOMATION_ADMIN`: `Project Automation Admin` `GROUP_BACKUP_ADMIN`: `Project Backup Admin` `GROUP_DATA_ACCESS_ADMIN`: `Project Data Access Admin` `GROUP_DATA_ACCESS_READ_ONLY`: `Project Data Access Read Only` `GROUP_DATA_ACCESS_READ_WRITE`: `Project Data Access Read/Write` `GROUP_MONITORING_ADMIN`: `Project Monitoring Admin` `GROUP_OWNER`: `Project Owner` `GROUP_READ_ONLY`: `Project Read Only` `GROUP_USER_ADMIN`: `Project 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.

Resposta

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: `GROUP_AUTOMATION_ADMIN` `GROUP_BACKUP_ADMIN` `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`
`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

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

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

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}