GET | Listar um dispositivo

Descrição

Acesse o modelo canônico completo de um dispositivo cadastrado no PAM Core, utilizando a API v2. Diferente do endpoint de listagem, este endpoint retorna todos os campos da entidade DeviceV2, incluindo criticality, owner, administrator_group, network_connector, connectivities e session_settings.

Pré-requisitos

• Autorização com permissão de leitura para o PAM Core, concedida pelo administrador no A2A. Para mais informações, acesse Como gerenciar autorizações no A2A API v2.
• Um dispositivo existente. Para criar um, acesse POST | Criar dispositivo (v2).

Requisição

GET /api/v2/platform/devices/{id}

Parâmetros de caminho

Parâmetros de query

Cabeçalhos

Exemplo de requisição

GET {{url}}/api/v2/platform/devices/55

Resposta

HTTP/1.1 200 OK

A resposta traz um cabeçalho ETag forte, que representa o estado atual do dispositivo, e um cabeçalho X-Request-Id, que correlaciona a requisição nos logs do Segura®. Guarde o ETag: ele é obrigatório no cabeçalho If-Match de PUT | Atualizar dispositivo (v2) e PATCH | Atualizar dispositivo (v2).

Todos os campos do modelo canônico são retornados, inclusive aqueles cujo valor é null. Um dispositivo inativo retorna 200 com active igual a false.

Exemplo de corpo da resposta

{
    "data": {
        "id": "55",
        "device": {
            "name": "db-prod-01",
            "address": "10.10.10.10",
            "active": true,
            "type": "Server",
            "vendor": "Oracle",
            "product": "Oracle Linux VM",
            "site": "SP-DC1",
            "domain_name": "CORP",
            "tags": ["prod", "database"],
            "criticality": "high",
            "owner": {
                "name": "John Doe"
            },
            "administrator_group": {
                "id": "5",
                "name": "PAM Admins"
            },
            "enable_remote_app": true,
            "network_connector": {
                "id": "12",
                "name": "NC-SP-01",
                "port": "50001"
            },
            "connectivities": [
                {
                    "protocol": "SSH",
                    "port": 22,
                    "connectable": true
                },
                {
                    "protocol": "RDP",
                    "port": 3389,
                    "connectable": false
                }
            ],
            "session_settings": [
                {
                    "connectivity": "SSH",
                    "expected_expression": "$",
                    "fill_in_value": "sudo su"
                }
            ]
        }
    },
    "meta": {
        "links": {
            "self": "/api/v2/platform/devices/55"
        },
        "actions": {
            "deactivate": "/api/v2/platform/devices/55/deactivate"
        }
    }
}

Campos do corpo da resposta

Erros

Exemplo de resposta de erro

404 o dispositivo não existe ou está fora do escopo da autorização:

{
    "error": {
        "code": "api.resource.not_found",
        "message": "The requested resource does not exist or is not accessible."
    }
}

Erros de autenticação

Documentos relacionados

• API v2 - Convenções e comportamentos compartilhados
• GET | Listar todos os dispositivos (v2)
• GET | Listar status de conexão do dispositivo (v2)
• PUT | Atualizar dispositivo (v2)
• PATCH | Atualizar dispositivo (v2)
• Como gerenciar autorizações no A2A API v2