Detail LDAP Configuration

This API returns the current LDAP configuration used to connect the system to an LDAP directory server.

Endpoint Details

URL	/v1/ldap/config
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Response

Here is an example of a response when viewing data details:

Response

{
    "config": {
        "id": "1a4026ed-013e-492e-ab0c-c0133c8fff40",
        "host": "ldap.example.com",
        "port": 636,
        "base_dn": "OU=Users,DC=example,DC=com",
        "bind_dn": "CN=Service Account,OU=Users,DC=example,DC=com",
        "enabled": true,
        "created_at": "2026-05-18T10:04:23+07:00",
        "updated_at": "2026-05-18T10:09:14+07:00"
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the LDAP configuration
host	String	Hostname or IP address of the LDAP server
port	Integer	Port used to connect to the LDAP server
base_dn	String	Base distinguished name used as the starting point for searches
bind_dn	String	Distinguished name of the account used to bind to the server
ssl	Boolean	Indicates whether the connection uses SSL
enabled	Boolean	Indicates whether the LDAP configuration is enabled
created_at	String	Creation timestamp in RFC 3339 date-time format
updated_at	String	Last update timestamp in RFC 3339 date-time format

---

info

• A valid Bearer Token is required to access this endpoint.
• The ssl field may not be present when the connection is not configured to use SSL.
• Timestamps are returned in RFC 3339 date-time format.