PATCH | Partially update LDAP server by [id]

Description

Change selected attributes of an LDAP/AD server connection profile in the Segura™ platform. The request follows the JSON Merge Patch format described in RFC 7396: it carries only the fields to change, and every field absent from the body keeps its current value.

To replace the complete configuration in one request, access PUT | 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

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

Path parameters

Headers

Request body

Every field is optional, and each field sent follows the rules it has in POST | Create LDAP server: host, port, dn_base, use_ssl, member_is_dn, bind_requires_dn, account_form, order, domain_id, bind_credential_id, network_connector_id, account_filter_format, use_credential_domain, ignore_disabled_expired, username_attribute, dn_bind, group, group_dn, group_attribute, group_scope, group_filter, and member_attribute.

Sending null in an optional field clears it. network_connector_id: null, for example, removes the network connector agent and returns the server to a direct connection.

Fields that cannot be changed

Sending any of them returns 422 patch.field.not.allowed.

Example request

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

Headers

Content-Type: application/merge-patch+json
If-Match: "a3f8c2e1d9b04567"

Body

{
    "port": 636,
    "use_ssl": true
}

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], with the changed fields already applied.

{
    "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": 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-12T14:11:07+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

422 the body carries a field that cannot be changed:

{
    "code": "patch.field.not.allowed",
    "message": "Field 'active' cannot be set via the API.",
    "details": [
        { "field": "active", "code": "patch.field.not.allowed" }
    ]
}

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