Get User Entries by Search Criteria – GET /WindowsDomains/{id}/UserEntries (v2.0 and up)
Owned by David P (Deactivated)
Get user entries according to specific search criteria.
The ‘Manage Users‘, Manage Authentication Providers’ or ‘Manage System Settings’ permission is required to execute this API.
Usage:
- GET /WindowsDomains/{id}/UserEntries and get user entries according to specific search criteria
- POST /Users and create a new user.
URL
cxrestapi/auth/WindowsDomains/{id}/UserEntries
Method:
GET
Media Type (header):
Authorization: Bearer <access token value>
Accept: application/json;v=1.0
Parameters
id=[integer] - Unique Id of the Windows domain
containsPattern=[string] - User name or full name contains pattern (e.g. dm)
Success Response:
Code: 200 Success
Error Response:
Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found
Sample Response:
[
{
"username": "admin",
"firstname": "Richard",
"lastname": "Smith",
"email": "admin@check.org"
}
]
Notes:
Retrieves user entries according to specific 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!