Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Criar uma chave API

Nesta página

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

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /orgs/{ORG-ID}/apiKeys
Nome
Tipo
Descrição

ORG-ID

string

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.

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 Ops Manager adiciona o campo status ao corpo da resposta.

none

Todos os parâmetros do corpo são obrigatórios.

Nome
Tipo
Descrição

desc

string

Descrição da chave API. Deve ter entre 1 e 250 caracteres.

roles

array de strings

Lista de funções que a chave API deve ter. Deve haver pelo menos uma função listada e todas as funções devem ser válidas para uma Organização.

As funções da organização incluem:

Valor da função na API
Função

ORG_OWNER

ORG_MEMBER

ORG_GROUP_CREATOR

ORG_READ_ONLY

Nome
Tipo
Descrição

id

string

Identificador exclusivo para a chave API

desc

string

Descrição da chave API

privateKey

string

Chave privada para a chave API. Esta chave aparece sem edição apenas no momento da criação.

publicKey

string

Chave pública para a chave de API

roles

array de objetos

Funções que a chave API tem

roles.orgId

string

O orgId representa a Organização à qual esta função se aplica.

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:

Valor da função na API
Função

ORG_OWNER

ORG_MEMBER

ORG_GROUP_CREATOR

ORG_READ_ONLY

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://<ops-manager-host>/api/public/v1.0/orgs/{ORG-ID}/apiKeys?pretty=true" \
--data '{
"desc" : "New API key for test purposes",
"roles": ["ORG_MEMBER"]
}'
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}

Observação

O privateKey aparece sem edição no corpo da resposta. Este exemplo foi redigido por motivos de segurança.

{
"desc" : "New API key for test purposes",
"id" : "{API-KEY-ID}",
"links" : [ {
"href" : "https://<ops-manager-host>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
"rel" : "self"
} ],
"privateKey" : "********-****-****-db2c132ca78d",
"publicKey" : "{PUBLIC-KEY}",
"roles" : [ {
"orgId" : "{ORG-ID}",
"roleName" : "ORG_MEMBER"
} ]
}

Voltar

Pegue um