Crie um segredo de 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
POST /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/secrets/
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
PROJECT-ID | string | Identificador exclusivo do Projeto ao qual pertence a conta de serviço de destino. 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 para a qual você deseja criar um segredo. Use 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 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 parâmetro de corpo é obrigatório.
Nome | Tipo | Descrição |
|---|---|---|
secretExpiresAfterHours | string | Número de horas após as quais o segredo desta conta de serviço expira. O mínimo é de 8 horas. O máximo é de 8766 horas (um ano). |
Resposta
Nome | Tipo | Descrição |
|---|---|---|
id | string | 24-string exclusivo de caracteres hexadecimais que identifica o segredo. |
secret | string | Segredo da conta de serviço, disponível apenas na criação. |
createdAt | timestamp | Timestamp representando o tempo de criação. |
expiresAt | timestamp | Timestamp representando o tempo de expiração secreto. |
Exemplo de solicitação
Observação
O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/secrets/?pretty=true" \ --data '{ "secretExpiresAfterHours": "3600" }'
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
201 Created 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
Observação
O secret não é editado no corpo da resposta. Este exemplo foi redigido por motivos de segurança.
{ "createdAt" : "2024-08-08T22:19:45Z", "expiresAt" : "2025-01-05T22:19:45Z", "id" : "66b544825867ba071c85469d", "secret" : "mdb_sa_sk_...AOk5" }