GET | Listar todas as chaves SSH

Descrição

Liste todas as chaves SSH associadas à sua autorização no PAM Core, utilizando o modelo canônico da API v2. O endpoint retorna uma projeção paginada da entidade SSHKeyV2 e oferece suporte a filtragem, ordenação e projeção de campos.

Valores secretos nunca são retornados. A resposta informa apenas se há uma chave privada ou uma senha configurada, por meio dos indicadores secret.has_private_key e secret.has_password.

Pré-requisitos

Autorização com permissão de leitura no PAM Core, concedida pelo administrador no A2A. Para mais informações, acesse Como gerenciar autorizações no A2A.

Requisição

GET /api/v2/pam/ssh-keys

Parâmetros de query

Os nomes dos filtros usam notação de ponto que espelha a estrutura da resposta. Apenas main_device_id é plano, porque referencia outra entidade por ID.

Filtros

A especificação afirma que este filtro é obrigatório. O refinamento de engenharia de 2026-07-15 questionou essa decisão e ela nunca foi fechada. Todos os demais filtros são opcionais.

Solicitar um valor secreto por meio da projeção de campos é rejeitado. Consulte a seção Erros.

Ordenação

sort_by aceita um ou mais campos da resposta e os valida contra uma lista permitida. Campos inválidos são rejeitados. Para o formato do parâmetro, a sintaxe de direção e a precedência entre múltiplos campos, consulte API v2 - Conventions and shared behaviors.

Paginação

Exemplo de requisição

GET {{url}}/api/v2/pam/ssh-keys?ssh_key.active=true&limit=50

Resposta

HTTP/1.1 200 OK

Exemplo de corpo da resposta

{
    "data": [
        {
            "id": "201",
            "key_name": "prod-deploy-key",
            "username": "deploy-user",
            "active": true,
            "main_device": { "id": "55", "hostname": "db-prod-01" },
            "credential_tags": ["prod", "ci-cd"],
            "has_private_key": true,
            "has_password": false,
            "last_used_at": "2026-01-29T12:34:56Z"
        }
    ],
    "meta": {
        "pagination": {
            "page": 1,
            "limit": 50,
            "total_items": 85,
            "total_pages": 2
        },
        "links": {
            "self": "/api/v2/pam/ssh-keys?page=1&limit=50",
            "first": "/api/v2/pam/ssh-keys?page=1&limit=50",
            "next": "/api/v2/pam/ssh-keys?page=2&limit=50",
            "last": "/api/v2/pam/ssh-keys?page=2&limit=50"
        }
    }
}

A projeção da listagem é plana. Cada item carrega os campos diretamente, e não dentro dos objetos ssh_key e secret retornados pelo endpoint de detalhe. Os nomes dos filtros continuam em notação de ponto, portanto secret.has_private_key filtra pelo campo que esta resposta retorna como has_private_key.

Campos do corpo da resposta

Toda resposta inclui o cabeçalho X-Request-Id. Informe esse valor ao entrar em contato com o time de suporte da Segura™ sobre uma requisição específica.

Erros

A API v2 retorna um code estruturado no corpo da resposta, junto a uma message legível. A coluna Mensagem da tabela a seguir apresenta esse código.

A especificação e o critério de aceite AC-01 exigem 403 com api.fields.sensitive.not.allowed. A build 4.2.13 retorna 422 com api.fields.invalid e a mensagem "Field 'secret.private_key' is not valid for this resource." Esta tabela registra o comportamento observado.

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

Documentos relacionados

• API v2 - Conventions and shared behaviors
• GET | Listar uma chave SSH por [id]
• Como gerenciar autorizações no A2A
• Sobre aplicações e autorizações no A2A