List LDAP Groups

This API returns the list of groups available in the connected LDAP directory server.

Endpoint Details

URL	/v1/ldap/groups
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 a list of data:

Response

{
    "groups": [
        {
            "dn": "CN=Taka Sales,OU=Taka,DC=prima,DC=net",
            "cn": "Taka Sales",
            "group_type": "-2147483646",
            "total_members": 5
        },
        {
            "dn": "CN=Taka Finance,OU=Taka,DC=prima,DC=net",
            "cn": "Taka Finance",
            "group_type": "-2147483646",
            "total_members": 4
        },
        {
            "dn": "CN=Taka Admin,OU=Taka,DC=prima,DC=net",
            "cn": "Taka Admin",
            "group_type": "-2147483646",
            "total_members": 3
        },
        {
            "dn": "CN=Taka IT,OU=Taka,DC=prima,DC=net",
            "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 response reflects the groups currently available in the connected LDAP directory server.