Descrição
Desative uma credencial no PAM Core. Uma credencial desativada continua armazenada e auditável, mas rejeita requisições de checkout, rotação e atualização.
Esta ação é a única forma de definir uma credencial como inativa. O campo active é derivado e não pode ser enviado em uma requisição de criação ou de atualização. Este endpoint faz parte da superfície da API v2 do A2A para credenciais. O equivalente na v1 está documentado em DELETE | Desabilitar credencial.
A API v2 não tem nenhum endpoint que exclua uma credencial permanentemente. A desativação é o único mecanismo disponível para retirar uma credencial de uso ativo. Uma credencial desativada por este endpoint mantém seu código de identificação, seu histórico e sua trilha de auditoria.
Pré-requisitos
- Uma autorização de aplicação concedida pelo administrador no A2A, com a permissão de recurso do PAM definida como Leitura e escrita. Para mais informações, acesse Como gerenciar autorizações no A2A.
- Um token de acesso OAuth 2.0 válido. Para mais informações, acesse Como autenticar uma aplicação no A2A.
- A credencial precisa estar ativa. Desativar uma credencial que já está inativa retorna
409.
Requisição
POST /api/v2/pam/credentials/{id}/deactivate
Parâmetros de caminho
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id |
integer | Sim | Código único de identificação da credencial. Nota: este valor é atribuído pelo Segura®. |
A requisição não tem corpo.
Exemplo de requisição
POST {{url}}/api/v2/pam/credentials/12/deactivate
Resposta
HTTP/1.1 204 No Content
A resposta não tem corpo. Para confirmar o novo estado, recupere a credencial com GET | Listar uma credencial por [id] e verifique o campo credential.active.
O que muda depois da desativação
| Operação | Comportamento em uma credencial inativa |
|---|---|
| Requisições de leitura | Funcionam. A credencial retorna 200 com credential.active definido como false. |
| Requisições de escrita e ações | Rejeitadas com 409 e o código api.resource.inactive. Isso cobre atualizações totais e parciais e a rotação de senha. |
| Ativação | Funciona. Use POST | Ativar credencial para devolver a credencial ao uso ativo. |
Erros
| Código HTTP | Mensagem | Causa possível | Solução |
|---|---|---|---|
401 |
api.auth.token.invalid |
O token de acesso está ausente ou expirou. | Solicite um novo token de acesso. |
403 |
api.permission.denied |
A autorização não tem permissão para atualizar credenciais. | Peça ao administrador para definir a permissão de recurso do PAM como Leitura e escrita no A2A e gere um novo token. |
404 |
api.resource.not_found |
A credencial não existe ou está fora do escopo da autorização. | Verifique o código de identificação enviado no caminho. |
409 |
api.resource.conflict.already_inactive |
A credencial já está inativa. | Nenhuma ação é necessária, a credencial já está no estado solicitado. |
429 |
rate_limit_exceeded |
O limite de requisições foi excedido. | Reduza a taxa de requisições e tente novamente. |
500 |
api.internal.error |
Erro interno do servidor. | Entre em contato com o time de suporte do Segura®. |
Exemplo de resposta de erro
409 a credencial já está inativa:
{
"error": {
"code": "api.resource.conflict.already_inactive",
"message": "Credential is already inactive."
}
}
Esta ação não é idempotente. Repeti-la em uma credencial que já está inativa retorna 409 em vez de 204. Recupere o estado atual da credencial antes de repetir uma requisição cujo resultado você não tem certeza.
Documentos relacionados
Para as mensagens de erro de autenticação, a política de 403 versus 404 e os limites atuais do bloco meta.actions, acesse API v2 - Convenções e comportamentos compartilhados.