Criar uma chave de API global
Nesta página
Crie uma chave deAPI global para o Ops Manager.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /admin/apiKeys
Funções obrigatórias
Requer que a chave de API que chama esse endpoint tenha a função Global Owner .
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Este endpoint não usa parâmetros de caminho de solicitação HTTP.
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. | false | ||||||
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não 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, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
| false |
Parâmetros do corpo da solicitação
Você deve fornecer todos os parâmetros do corpo da solicitação.
Nome | Tipo | necessidade | Descrição | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
desc | string | Obrigatório | Descrição da chave API global. Deve ter entre 1 e 250 caracteres. | ||||||||||||||
roles | array de strings | Obrigatório | Lista de funções que a chave de API global precisa ter. Se a matriz
As funções globais aceitas por padrão incluem:
|
Resposta
Nome | Tipo | Descrição | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
desc | string | Descrição desta chave de API global. | ||||||||||||||
id | string | Identificador exclusivo para esta chave de API global. | ||||||||||||||
links | string | Uma array de documentos, representando um link para um ou mais sub-recursos e/ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações. | ||||||||||||||
privateKey | string | Chave privada não editada para esta chave de API global. | ||||||||||||||
publicKey | string | Chave pública para esta chave de API global. | ||||||||||||||
roles | array de objetos | Funções que esta chave de API global tem. Essa matriz retorna todos os roles globais que o usuário tem no Ops Manager. | ||||||||||||||
roles.roleName | string | Nome da função. Esse recurso retorna todos os roles que o usuário tem no Ops Manager. Os valores possíveis são:
|
Exemplo de solicitação
Observação
O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}.
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true" \ 6 --data '{ 7 "desc" : "New API key for Global Testing", 8 "roles" : [ "GLOBAL_READ_ONLY", "GLOBAL_USER_ADMIN" ] 9 }'
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
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
1 { 2 "desc" : "New API key for Global Testing", 3 "id" : "5d669ce780eef52a42cf0e1e", 4 "links" : [ { 5 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", 6 "rel" : "self" 7 } ], 8 "privateKey" : "8d080e57-5fd6-495c-9388-fe348ed1796f", 9 "publicKey" : "cfswjfck", 10 "roles" : [ { 11 "roleName" : "GLOBAL_READ_ONLY" 12 }, { 13 "roleName" : "GLOBAL_USER_ADMIN" 14 } ] 15 }