Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Contas de serviço
/
Contas da organização

Obter todas as contas de serviço

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Resposta
  • documento de resposta
  • results documento incorporado
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

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

Resource

GET /orgs/{ORG-ID}/serviceAccounts

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.

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 "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

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos 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.

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

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/orgs/{ORG-ID}/serviceAccounts?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/1234567890abcdef12345678/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=3",
      "rel": "self"
    }
  ],
  "results": [
    {
      "createdAt": "2024-04-23T20:36:22Z",
      "description": "Service account for development team",
      "clientId": "mdb_sa_id_001",
      "name": "dev-team-sa",
      "roles": ["ORG_OWNER"],
      "secrets": [
        {
          "createdAt": "2024-04-23T20:36:22Z",
          "expiresAt": "2024-12-01T00:00:00Z",
          "id": "secret_id_001",
          "lastUsedAt": "2024-04-23T20:49:19Z",
          "maskedSecretValue": "mdb_sa_sk_…OEyV"
        }
      ]
    },
    {
      "createdAt": "2024-05-31T17:27:05Z",
      "description": "Service account for billing operations",
      "clientId": "mdb_sa_id_002",
      "name": "billing-sa",
      "roles": ["ORG_BILLING_ADMIN"],
      "secrets": [
        {
          "createdAt": "2024-05-31T17:27:05Z",
          "expiresAt": "2025-05-31T17:27:05Z",
          "id": "secret_id_002",
          "maskedSecretValue": "mdb_sa_sk_…OTyG"
        }
      ]
    },
    {
      "createdAt": "2024-06-04T18:31:42Z",
      "description": "Service account for project management",
      "clientId": "mdb_sa_id_003",
      "name": "project-mgmt-sa",
      "roles": ["ORG_MEMBER"],
      "secrets": [
        {
          "createdAt": "2024-06-04T18:31:42Z",
          "expiresAt": "2024-09-02T18:31:42Z",
          "id": "secret_id_003",
          "maskedSecretValue": "mdb_sa_sk_…OWyP"
        }
      ]
    }
  ],
  "totalCount": 3
}

Voltar

Contas da organização

Próximo

Pegue um