Obter uma conta de serviço
Nesta página
O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
ORG-ID | string | O identificador exclusivo da organização cuja conta de serviço você deseja recuperar. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso. |
CLIENT-ID | string | O identificador exclusivo da conta de serviço que você deseja recuperar. Solicite o endpoint /orgs/{ORG-ID}/serviceAccounts para recuperar todas as contas de serviço da organização especificada à qual o usuário autenticado tem acesso. |
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 estar em um prettyprint formato. | 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 Para endpoints que retornam um resultado, o corpo da resposta inclui:
Para endpoints que retornam uma lista de resultados, o objeto | none |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
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. |
description | string | 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 -. |
name | string | 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 -. |
createdAt | timestamp | Hora de criação da conta de serviço. |
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.secret | string | Segredo da conta de serviço, disponível apenas na criação. |
secrets.maskedSecretValue | string | Segredo oculto que exibe apenas o prefixo e os últimos quatro caracteres. |
secrets.createdAt | timestamp | Timestamp representando o tempo de criação do segredo. |
secrets.lastUsedAt | timestamp | Registro de data/hora representando o último uso secreto. |
secrets.expiresAt | timestamp | Timestamp representando o tempo de expiração secreto. |
roles | array de objetos | Roles que a conta de serviço tem na organização. As funções da organização incluem: |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}?pretty=true"
Exemplo de resposta
Cabeçalho de resposta
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
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
{ "createdAt" : "2024-05-31T17:27:05Z", "description" : "This service account is for admins.", "clientId" : "mdb_sa_id_665a086958c92d31a28d452e", "name" : "Admin Service Account", "roles" : [ "ORG_OWNER" ], "secrets" : [ { "createdAt" : "2024-05-31T17:27:05Z", "expiresAt" : "2025-05-31T17:27:05Z", "id" : "665a086958c92d31a28d452f", "maskedSecretValue" : "mdb_sa_sk_…OEyV" } ] }