Get User Entries by Search Criteria - GET /LDAPServers/{id}/UserEntries

Get LDAP Server user entries according to specific search criteria.

Usage:

1. GET /LDAPServers/{id}/UserEntries and get LDAP Server user entries according to specific search criteria
2. POST /Users and create a new user

URL

/cxrestapi/auth/LDAPServers/{id}/UserEntries

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

Required:

id=[integer] - Unique Id of the LDAP Server. LDAP Server Id (id) is retrieved using the LDAP Servers API.
userNameContainsPattern=[string] – User name contains pattern (e.g. cn=admin,dc=example,dc=com)

Success Response:

Code: 200 Success

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found

Sample Response:

[
  {
    "username": "admin1",
    "firstName": "James",
    "lastName": "Smith",
    "email": admin@cx.org
  }
]

Notes:

Retrieves LDAP Server user entries according to the specified search criteria. If the request fails, it returns an error response.

Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!