GET | Listar uma chave SSH por [id]

Descrição

Acesse o registro completo de uma chave SSH no PAM Core, utilizando o modelo canônico da API v2. A resposta retorna a estrutura SSHKeyV2 completa, incluindo os dispositivos associados, as configurações de sessão e as configurações de renovação da chave.

Uma chave SSH inativa retorna 200 com ssh_key.active definido como false. Ela não é tratada como inexistente.

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.
• Um token de acesso OAuth 2.0 válido. Para mais informações, acesse Como autenticar uma aplicação A2A.

Requisição

GET /api/v2/pam/ssh-keys/{id}

Parâmetros de caminho

Parâmetros de query

Campos sensíveis: nunca retornados

ssh_key.private_key e ssh_key.password são classificados como secretos. Eles nunca são incluídos na resposta e não podem ser solicitados por meio de fields. A resposta informa apenas se cada um está configurado, por meio de secret.has_private_key e secret.has_password.

Exemplos de requisição

GET {{url}}/api/v2/pam/ssh-keys/2267

Com projeção de campos:

GET {{url}}/api/v2/pam/ssh-keys/2267?fields=ssh_key.key_name,ssh_key.active,secret.has_private_key

Resposta

HTTP/1.1 200 OK

Exemplo de corpo da resposta: canônico completo

{
    "data": {
        "id": "2267",
        "ssh_key": {
            "key_name": "key_segura",
            "username": "key_segura",
            "active": true,
            "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI...",
            "ssh_key_algorithm": "rsa",
            "credential_tags": ["prod", "ci-cd"],
            "ssh_key_owner": {
                "name": "John Doe"
            },
            "last_used_at": "2026-08-29T12:34:56Z",
            "device_tags": ["prod", "database"]
        },
        "secret": {
            "has_private_key": true,
            "has_password": false,
            "type": "ssh-key"
        },
        "main_device": {
            "id": "159",
            "hostname": "dev",
            "management_ip": "10.10.10.6"
        },
        "devices": [
            {
                "id": "159",
                "hostname": "dev",
                "product": "Oracle Linux VM",
                "device_type": "Server",
                "site": "SP-DC1",
                "domain_name": "CORP"
            }
        ],
        "session": {
            "use_own_credential": false,
            "authentication_credential": {
                "id": "88",
                "username": "auth-user"
            },
            "authentication_device": {
                "id": "159",
                "hostname": "dev"
            },
            "automation_macros": [
                {
                    "id": "5",
                    "name": "ERP Access",
                    "connectivity": "SSH"
                }
            ],
            "restrict_remote_app_only": true
        },
        "key_renewal": {
            "automatic_change_enabled": true,
            "set_password_on_renewal": true,
            "use_key_itself_to_connect": false,
            "authentication_credential": {
                "id": "90",
                "username": "renew-user"
            }
        }
    },
    "meta": {
        "links": {
            "self": "/api/v2/pam/ssh-keys/2267"
        },
        "actions": {
            "activate": "/api/v2/pam/ssh-keys/2267/activate",
            "deactivate": "/api/v2/pam/ssh-keys/2267/deactivate",
            "rotate": "/api/v2/pam/ssh-keys/2267/rotate"
        }
    }
}

A especificação lista cinco ações, mas o checkout não está disponível nesta versão e a situação do check-in não está resolvida. Confirme quais chaves a build realmente retorna.

Exemplo de corpo da resposta: com projeção de campos

{
    "data": {
        "id": "2267",
        "ssh_key": {
            "key_name": "key_segura",
            "active": true
        },
        "secret": {
            "has_private_key": true
        }
    },
    "meta": {
        "links": {
            "self": "/api/v2/pam/ssh-keys/2267?fields=ssh_key.key_name,ssh_key.active,secret.has_private_key"
        }
    }
}

A projeção preserva a estrutura aninhada. Os campos solicitados são retornados em sua posição canônica, e não de forma plana.

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.

Exemplo de resposta de erro

422 um valor secreto foi solicitado por meio de fields:

{
    "code": "api.fields.invalid",
    "message": "Field 'secret.private_key' is not valid for this resource.",
    "details": null
}

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 o 422 apresentado. Este documento registra o comportamento observado.

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

Documentos relacionados

• API v2 - Conventions and shared behaviors
• GET | Listar todas as chaves SSH
• POST | Rotacionar chave SSH
• Como gerenciar autorizações no A2A