Search LDAP Group

This API searches for groups in the connected LDAP directory server that match the provided keyword.

Endpoint Details

URL	/v1/ldap/groups-search
Method	POST
Authorization	Bearer Token

---

Request Headers

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

---

Request Body

Use the following format to make a request:

JSON Request

{
  "keyword": "Taka IT"
}

---

Parameters

Parameter	Type	Description
keyword	String	Keyword used to search for matching LDAP groups

---

Response

Here is an example response after the request has been successfully processed:

Response

{
    "groups": [
        {
            "dn": "CN=Taka IT,OU=Groups,DC=example,DC=com",
            "cn": "Taka IT",
            "group_type": "-2147483646",
            "total_members": 2
        }
    ]
}

---

Field Descriptions

Field	Type	Description
dn	String	Distinguished name of the group in the LDAP directory
cn	String	Common name of the group
group_type	String	LDAP group type value
total_members	Integer	Number of members in the group

---

info

• A valid Bearer Token is required to access this endpoint.
• The keyword is matched against the group's common name in the LDAP directory.
• Only groups from the connected LDAP directory server are returned.