PUT | Update LDAP server by [id]

Description

Replace every attribute of an LDAP/AD server connection profile in the Segura™ platform. The request carries the complete configuration, so any optional field left out is cleared.

To change a few fields and leave the rest untouched, access PATCH | Partially update LDAP server by [id].

Prerequisites

• An application with the Users authorization granted by the administrator in A2A, and its resource permission set to Read and write. For more information, access How to manage authorizations in A2A.
• A valid OAuth 2.0 access token. For more information, access How to authenticate an application in A2A.
• The server's current version, read from the ETag header returned by GET | List an LDAP server by [id].
• The server must be active. Access POST | Activate LDAP server first when it is not.

Request

PUT /api/v2/iam/ldap-servers/{id}

Path parameters

Headers

Request body

The body takes the same fields as POST | Create LDAP server, with the same rules.

Example request

PUT {{url}}/api/v2/iam/ldap-servers/7

Headers

If-Match: "a3f8c2e1d9b04567"

Body

{
    "host": "ad.example.com",
    "port": 636,
    "dn_base": "CN=Users,DC=example,DC=com",
    "use_ssl": true,
    "member_is_dn": false,
    "bind_requires_dn": true,
    "account_form": "principal",
    "order": 1,
    "domain_id": 5,
    "bind_credential_id": 102,
    "use_credential_domain": false,
    "ignore_disabled_expired": true,
    "dn_bind": "CN=svc-ldap,OU=Service Accounts,DC=example,DC=com"
}

Response

HTTP/1.1 200 OK
ETag: "b7c1e4f2a8d93016"

The ETag header holds the server's new version. Use it in the If-Match header of the next write.

Example response body

The response carries the complete server, in the same shape as GET | List an LDAP server by [id].

{
    "data": {
        "id": 7,
        "ldap_server": {
            "host": "ad.example.com",
            "port": 636,
            "dn_base": "CN=Users,DC=example,DC=com",
            "active": true,
            "use_ssl": true,
            "member_is_dn": false,
            "bind_requires_dn": true,
            "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": true,
            "username_attribute": null,
            "dn_bind": "CN=svc-ldap,OU=Service Accounts,DC=example,DC=com",
            "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-12T14:03:51+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"
        }
    }
}

Response body fields

The response fields match GET | List an LDAP server by [id].

Errors

Example error response

428 the request arrived without the If-Match header:

{
    "code": "api.precondition.required",
    "message": "If-Match header is required for this request.",
    "details": null
}

For authentication error messages and the 403 versus 404 policy, access API v2 - Conventions and shared behaviors.