Excluir uma chave de API global
Nesta página
Exclua uma chave deAPI global do Ops Manager usando o identificador exclusivo para essa chave.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Recurso
DELETE /admin/apiKeys/{API-KEY-ID}
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
Todos os parâmetros do caminho da solicitação são obrigatórios.
Nome | Tipo | Descrição |
|---|---|---|
API-KEY-ID | string | Identificador único da chave de API que você deseja excluir. Use o endpoint /admin/apiKeys para recuperar todas as chaves de API às quais o usuário autenticado tem acesso. |
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
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Este endpoint não tem elementos de resposta.
Exemplo de solicitação
1 curl --user "{USERNAME}:{APIKEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request DELETE "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"
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
204 No Content 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
Este endpoint não retorna um corpo de resposta.