POST | Desativar chave SSH

Descrição

Desative uma chave SSH no PAM Core. Uma chave desativada mantém sua configuração e continua legível, mas rejeita a rotação e as demais operações de escrita.

Desativar não é excluir. A chave continua aparecendo em GET | Listar todas as chaves SSH e continua retornando 200 em GET | Listar uma chave SSH por [id], com ssh_key.active definido como false.

Attention

Desativar uma chave da qual uma automação depende interrompe essa automação. Uma operação de escrita sobre uma chave inativa retorna 409 com api.resource.inactive.

Pré-requisitos

Autorização com permissão de leitura e escrita no PAM Core, concedida pelo administrador no A2A. 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 A2A.
A chave SSH deve estar ativa. Desativar uma chave já inativa retorna 409.

Requisição

POST /api/v2/pam/ssh-keys/{id}/deactivate

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
`id`	string	Sim	Código único de identificação da chave SSH, atribuído pela Segura™.

A requisição não tem corpo.

Exemplo de requisição

POST {{url}}/api/v2/pam/ssh-keys/2267/deactivate

Resposta

HTTP/1.1 204 No Content

A resposta não tem corpo. Para confirmar o novo estado, consulte a chave com GET | Listar uma chave SSH por [id] e verifique ssh_key.active.

Erros

A API v2 retorna um code estruturado no corpo da resposta, junto a uma message legível.

Código HTTP	Mensagem	Causa possível	Solução
`401`	`api.auth.token.invalid`	O token de acesso está ausente, expirado ou inválido.	Solicite um novo token de acesso e reenvie a requisição.
`403`	`api.permission.denied`	A autorização não tem permissão de escrita nos recursos do PAM Core.	Peça ao administrador para verificar as permissões da autorização no A2A e gere um novo token.
`404`	`api.resource.not_found`	A chave SSH 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 chave SSH já está inativa.	Nenhuma ação é necessária. A chave já está no estado solicitado.
`429`	`rate_limit_exceeded`	O limite de requisições foi excedido.	Reduza a frequência das requisições e tente novamente.
`500`	`api.internal.error`	Erro interno do servidor.	Entre em contato com o time de suporte da Segura™.

Exemplo de resposta de erro

409 a chave já está inativa:

{
    "code": "api.resource.conflict.already_inactive",
    "message": "SSH key is already inactive.",
    "details": null
}

Info

Esta ação não é idempotente. Repeti-la em uma chave que já está inativa retorna 409, e não 204. Consulte o estado atual da chave antes de repetir uma requisição cujo resultado você não conhece.

Para as mensagens de erro de autenticação e a política de 403 versus 404, acesse API v2 - Conventions and shared behaviors.