Skip to main content

DELETE Revogar API Key

Revoga uma API key da clínica. A chave deixa de funcionar quase de imediato: o resultado da validação fica em cache por até cerca de 60 segundos, e a revogação por esta rota limpa esse cache.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário). Veja Autenticação.

Só com token de usuário

Com x-api-key a resposta é 403: a rota depende do usuário do token.

Permissão necessária

Exige a permissão update_roles.


Endpoint​

DELETE https://api-dev.imagemais.com.br/api/api-keys/{id}

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idstring✅Id da chave (api_key_ + 26 caracteres), como devolvido por Listar API Keys

Requisição​

curl -X 'DELETE' \n 'https://api-dev.imagemais.com.br/api/api-keys/api_key_01HXXXXXXXXXXXXXXXXXXXXXXX' \n -H 'accept: application/json' \n -H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

Sem corpo de resposta.

400 Id inválido​

{
"message": "API key inválida",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão ou chamada com API Key​

Sem a permissão da rota (Permissões insuficientes) ou chamada feita com x-api-key:

{
"message": "API keys só podem ser geridas por um usuário logado.",
"error": "Forbidden",
"statusCode": 403
}

404 Chave não encontrada​

Inclui chave de outra clínica.

{
"message": "API key não encontrada",
"error": "Not Found",
"statusCode": 404
}

503 Serviço de login indisponível​

{
"message": "Não foi possível falar com o serviço de login. Tente novamente em instantes.",
"error": "Service Unavailable",
"statusCode": 503
}