Search LDAP User
This API searches for users in the connected LDAP directory server that match the provided keyword.
Endpoint Details
| URL | /v1/ldap/users |
| 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": "member_aplikasi"
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| keyword | String | Keyword used to search for matching LDAP users |
Response
Here is an example response after the request has been successfully processed:
Response
{
"users": [
{
"dn": "CN=member aplikasi,OU=Taka,DC=prima,DC=net",
"sam_account_name": "member_aplikasi",
"mail": "memberaplikasi720@gmail.com",
"user_principal_name": "member_aplikasi@prima.net",
"display_name": "member aplikasi",
"given_name": "member",
"sn": "aplikasi",
"cn": "member aplikasi"
}
]
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| dn | String | Distinguished name of the user in the LDAP directory |
| sam_account_name | String | SAM account name of the user |
| String | Email address of the user | |
| user_principal_name | String | User principal name (UPN) of the user |
| display_name | String | Display name of the user |
| given_name | String | Given (first) name of the user |
| sn | String | Surname (last name) of the user |
| cn | String | Common name of the user |
info
- A valid Bearer Token is required to access this endpoint.
- The
keywordis matched against LDAP user attributes such as the SAM account name, display name, and email. - Only users from the connected LDAP directory server are returned.