Descrição
Devolva uma chave SSH após o uso no PAM Core. A ação libera o lease de checkout ativo, o que torna a chave disponível a outros consumidores.
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.
Requisição
POST /api/v2/pam/ssh-keys/{id}/checkin
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/checkin
Resposta
HTTP/1.1 204 No Content
A resposta não tem corpo.
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. |
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™. |
A especificação não informa. O código de conflito de checkout api.resource.conflict.checkout_active existe para o caso oposto, mas nenhum código está definido para um check-in sem lease ativo. Portanto, esta tabela de erros está incompleta.
Para as mensagens de erro de autenticação e a política de 403 versus 404, acesse API v2 - Conventions and shared behaviors.