POST | Criar servidor LDAP

Descrição

Crie um perfil de conexão de servidor LDAP/AD na plataforma Segura™. Uma única requisição define o host e a porta, a credencial PAM usada no bind, a DN base, o formato da conta, a ordem de avaliação na cadeia de autenticação e os parâmetros de consulta de grupo.

O servidor é criado no estado ativo e entra imediatamente na cadeia de autenticação. É o mesmo registro que a interface web gerencia em Settings > Authentication > LDAP/AD: um servidor criado aqui aparece lá, e vice-versa.

Pré-requisitos

• Uma aplicação com a autorização Users concedida pelo administrador no A2A, com a permissão do recurso definida como Leitura e escrita. 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.
• Um domínio cadastrado na plataforma, para referenciar em domain_id.
• Uma credencial PAM contendo a conta de bind, para referenciar em bind_credential_id.

Requisição

POST /api/v2/iam/ldap-servers

Cabeçalhos

Corpo da requisição

Exemplo de requisição

POST {{url}}/api/v2/iam/ldap-servers

Corpo

{
    "host": "ad.example.com",
    "port": 389,
    "dn_base": "CN=Users,DC=example,DC=com",
    "use_ssl": false,
    "member_is_dn": false,
    "bind_requires_dn": false,
    "account_form": "principal",
    "order": 1,
    "domain_id": 5,
    "bind_credential_id": 102,
    "use_credential_domain": false,
    "ignore_disabled_expired": false
}

Resposta

HTTP/1.1 201 Created
Location: /api/v2/iam/ldap-servers/7

O cabeçalho Location contém o caminho do servidor criado.

Exemplo de corpo da resposta

{
    "data": {
        "id": 7,
        "ldap_server": {
            "host": "ad.example.com",
            "port": 389,
            "dn_base": "CN=Users,DC=example,DC=com",
            "active": true,
            "use_ssl": false,
            "member_is_dn": false,
            "bind_requires_dn": false,
            "account_form": "principal",
            "order": 1,
            "domain": { "id": 5, "name": "EXAMPLE.COM" },
            "bind_credential": {
                "id": 102,
                "username": "[email protected]",
                "domain": { "id": 5, "name": "EXAMPLE.COM" }
            },
            "network_connector": null,
            "account_filter_format": null,
            "use_credential_domain": false,
            "ignore_disabled_expired": false,
            "username_attribute": null,
            "dn_bind": null,
            "account_domain_name": "EXAMPLE.COM",
            "account_domain_name_short": "EXAMPLE",
            "group": null,
            "group_dn": null,
            "group_attribute": null,
            "group_scope": null,
            "group_filter": null,
            "member_attribute": null,
            "created_at": "2026-05-08T22:42:34+00:00",
            "updated_at": "2026-05-08T22:42:34+00:00"
        }
    },
    "meta": {
        "links": { "self": "/api/v2/iam/ldap-servers/7" },
        "actions": {
            "test-connection": "/api/v2/iam/ldap-servers/7/test-connection",
            "deactivate": "/api/v2/iam/ldap-servers/7/deactivate"
        }
    }
}

Campos do corpo da resposta

Erros

Exemplo de resposta de erro

422 outro servidor ativo já usa o valor de order:

{
    "code": "api.validation.order.duplicate",
    "message": "Another active LDAP server already uses this order.",
    "details": [
        { "field": "order", "code": "api.validation.order.duplicate" }
    ]
}

Para mensagens de erros de autenticação e a política de 403 versus 404, acesse API v2 - Convenções e comportamentos compartilhados.