Atualize os valores de uma chave de API global do Ops Manager usando o identificador exclusivo para essa chave.
Para encontrar uma Chave de API global específica, obtenha a lista de Chaves de API globais e, em seguida, encontre o {API-KEY-ID} de que você precisa.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /admin/apiKeys/{API-KEY-ID}Funções obrigatórias
Exige que a API Key chamando este ponto de extremidade tenha o Global Owner função.
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Todos os parâmetros do caminho da solicitação são obrigatórios.
Nome | Tipo | Descrição |
|---|---|---|
| string | Identificador exclusivo da chave de API global que você deseja atualizar. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que 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, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui:
|
|
Parâmetros do corpo da solicitação
Você deve fornecer um ou ambos os dois parâmetros do corpo.
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
| string | Condicional | Descrição da chave. Este parâmetro é opcional; no entanto, a solicitação deve conter um parâmetro |
| array de strings | Condicional | Lista de funções que a Chave API Global precisa ter. Se o array
As funções globais aceitas por padrão incluem:
|
Resposta
Nome | Tipo | Descrição |
|---|---|---|
| string | Descrição desta chave de API global. |
| string | Identificador exclusivo para esta chave de API global. |
| string | Um array de documentos que representa um link para um ou mais sub-recursos ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações. |
| string | Chave privada editada para esta chave de API global. |
| string | Chave pública para esta chave de API global. |
| 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. |
| 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}.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \ --data '{ "desc" : "Updated API key description for test purposes" }'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-aliveHTTP/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
{ "created": "2019-09-04T15:37:40Z", "desc": "Updated API key description for test purposes", "globalRoles": ["GLOBAL_READ_ONLY"], "groupRoles": [], "numGroups": 0, "orgRoles": [], "orgRolesString": "", "privateKey": "********-****-****-cfe60e9f1f72", "userId": "5d6fda44ff4ab7133648a852", "username": "dczverfw"}