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.

Obter todas as contas de serviço da organização atribuídas a um projeto

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

Resource

GET /groups/{PROJECT-ID}/serviceAccounts

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

PROJECT-ID

string

Identificador exclusivo do projeto do qual você deseja recuperar as contas de serviço da organização atribuídas. Use o endpoint /groups para extrair todos os projetos aos quais 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 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

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos de result, uma array de objetos de link e uma contagem do número total de objetos de result recuperados.

Nome
Tipo
Descrição

results

array

A array inclui um objeto para cada item detalhado na seção results Documento incorporado.

links

array

A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.

totalCount

número

Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada resultado é uma conta de serviço do Projeto.

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

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" \     --include \     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?pretty=true"

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

{  "links": [    {      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/66ae30345fe4416479e39269/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=100",      "rel": "self"    }  ],  "results": [    {      "createdAt": "2024-08-03T14:02:40Z",      "description": "Service account for Cloud Manager users.",      "clientId": "mdb_sa_id_66ae38803cdf55582cb01144",      "name": "General Access",      "roles": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"],      "secrets": [        {          "createdAt": "2024-08-03T14:02:40Z",          "expiresAt": "2024-12-31T14:02:40Z",          "lastUsedAt" : "2024-08-24T21:10:35Z",          "id": "66ae38803cdf55582cb01143",          "maskedSecretValue": "mdb_sa_sk_...hcOL"        }      ]    },    {      "createdAt": "2024-08-03T14:05:20Z",      "description": "Service account for read access.",      "clientId": "mdb_sa_id_66ae38803cdf55582cb01145",      "name": "Read Only Access",      "roles": ["GROUP_READ_ONLY"],      "secrets": [        {          "createdAt": "2024-08-03T14:05:20Z",          "expiresAt": "2024-12-31T14:05:20Z",          "lastUsedAt" : "2024-08-24T21:10:35Z",          "id": "66ae38803cdf55582cb01146",          "maskedSecretValue": "mdb_sa_sk_...jcOP"        }      ]    },    {      "createdAt": "2024-08-03T14:10:00Z",      "description": "Service account for data backup.",      "clientId": "mdb_sa_id_66ae38803cdf55582cb01147",      "name": "Backup Access",      "roles": ["GROUP_DATA_BACKUP_ADMIN"],      "secrets": [        {          "createdAt": "2024-08-03T14:10:00Z",          "expiresAt": "2024-12-31T14:10:00Z",          "lastUsedAt" : "2024-08-24T21:10:35Z",          "id": "66ae38803cdf55582cb01148",          "maskedSecretValue": "mdb_sa_sk_...kcQR"        }      ]     }   ],  "totalCount": 3}
Voltar
Contas do projeto
Próximo
Pegue um
Avalie esta página

Nesta página