POST | Criar dispositivo

Descrição

Crie um dispositivo no PAM Core utilizando a API v2. Uma única requisição define a identidade do dispositivo, seus protocolos de conectividade, sua criticidade, sua associação a um Network Connector e suas configurações de sessão.

Pré-requisitos

• Autorização com permissão de escrita para o PAM Core, concedida pelo administrador no A2A. Para mais informações, acesse Como gerenciar autorizações no A2A API v2.
• Os valores enviados em type, vendor, product, site e domain_name precisam estar previamente cadastrados. Cadastre-os em Tipos, Fabricantes, Modelos e Sites. Um valor não cadastrado retorna 422.
• Para associar um Network Connector, o conector precisa existir previamente. Para mais informações, acesse Como configurar dispositivos no Network Connector.

Requisição

POST /api/v2/platform/devices

Corpo da requisição

Os campos de lookup são referenciados por nome, enquanto o Network Connector e o grupo administrador são referenciados por id. A resposta expande as referências por id em objetos.

Cada criação também enfileira uma pipeline completa de processamento de políticas de acesso, para que o dispositivo se torne visível na interface web. As pipelines não são agrupadas: provisionar dispositivos em lote enfileira uma pipeline por dispositivo. Leve isso em conta ao automatizar provisionamento em massa.

Exemplo de requisição

POST {{url}}/api/v2/platform/devices

Corpo

{
    "name": "db-prod-01",
    "address": "10.10.10.10",
    "type": "Server",
    "vendor": "Oracle",
    "product": "Oracle Linux VM",
    "site": "SP-DC1",
    "domain_name": "CORP",
    "tags": ["prod", "database"],
    "owner": "jdoe",
    "criticality": "high",
    "enable_remote_app": true,
    "network_connector_id": 12,
    "connectivities": [
        {
            "protocol": "SSH",
            "port": 22
        },
        {
            "protocol": "RDP",
            "port": 3389
        }
    ],
    "session_settings": [
        {
            "connectivity": "SSH",
            "expected_expression": "$",
            "fill_in_value": "sudo su"
        }
    ]
}

Resposta

HTTP/1.1 201 Created
Location: /api/v2/platform/devices/55

O cabeçalho Location traz o caminho do dispositivo criado. O dispositivo é criado com active igual a true, e cada protocolo em connectivities começa com connectable igual a false até que o primeiro teste de conectividade seja executado.

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": null,
            "enable_remote_app": true,
            "network_connector": {
                "id": "12",
                "name": "NC-SP-01",
                "port": "50001"
            },
            "connectivities": [
                {
                    "protocol": "SSH",
                    "port": 22,
                    "connectable": false
                },
                {
                    "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

A resposta retorna o dispositivo criado com os mesmos campos de GET | Listar um dispositivo (v2). Acesse esse documento para as tabelas completas de campos.

Erros

Exemplo de resposta de erro

422 um fabricante referenciado não está cadastrado:

{
    "error": {
        "code": "api.validation.invalid_reference",
        "message": "The referenced vendor does not exist.",
        "details": [
            {
                "field": "vendor",
                "code": "api.validation.invalid_reference"
            }
        ]
    }
}

Erros de autenticação

Documentos relacionados

• API v2 - Convenções e comportamentos compartilhados
• GET | Listar um dispositivo (v2)
• PUT | Atualizar dispositivo (v2)
• PATCH | Atualizar dispositivo (v2)
• POST | Desativar dispositivo (v2)
• Como gerenciar autorizações no A2A API v2
• Cadastro de dispositivo