Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Chaves de API programáticas
/
Chaves de API programáticas da organização

Obter todas as chaves API

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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /orgs/{ORG-ID}/apiKeys

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição
ORG-ID
string
O identificador exclusivo daorganização cujas chaves de API 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:

Status
Código de resposta HTTP
envelope
Corpo de resposta esperado

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops 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 Documento incorporadoresults .
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 chave de API.

Nome
Tipo
Descrição
id
string
Identificador exclusivo para a chave API
desc
string
Descrição da chave API
privateKey
string
Chave privada editada para a chave de API
publicKey
string
Chave pública para a chave de API
roles
array de objetos
Funções que a chave API tem
roles.{ENTITY-ID}
string
O {ENTITY-ID} representa a organização ou projeto ao qual esta função se aplica. Os valores possíveis são: orgId ou groupId.
roles.roleName
string

O nome da role. O recurso users retorna todos os papéis que o usuário tem no MongoDB Atlas ou Ops Manager. Os valores possíveis são:

  • Roles da organização

    Valor da função na API
    Função
    ORG_OWNER
    ORG_MEMBER
    ORG_GROUP_CREATOR
    ORG_READ_ONLY

  • Roles do projeto

    Grupos e projetos são termos sinônimos.

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

Exemplo de solicitação

Observação

O usuário que faz a solicitação pode ser formatado como {USERNAME}:{APIKEY} ou {PUBLIC-KEY}:{PRIVATE-KEY}.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys?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://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d97029d82e3f6/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "desc" : "Test Docs Service User",
    "id" : "5c47503320eef5699e1cce8d",
    "links" : [ {
      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d98829d82e3f6/apiKeys/5c47503ae0eef5699e1cce8d",
      "rel" : "self"
    } ],
    "privateKey" : "********-****-****-db2c132ca78d",
    "publicKey" : "ewmaqvdo",
    "roles" : [ {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_READ_ONLY"
    }, {
      "orgId" : "5980cfc70b6d97029d82e3f6",
      "roleName" : "ORG_MEMBER"
    } ]
  } ],
  "totalCount" : 1
}

Voltar

Chaves de API programáticas da organização

Próximo

Obter uma chave API