- URL:https://<users-url>/searchEnterpriseUsers(POST only)
- Required Capability:Default administrator role | Security and infrastructure privilege | Add privilege
- Related Resources:Search Enterprise Groups
- Version Introduced:10.3
Description
This operation searches users in the configured enterprise user store. You can narrow down the search using the filter parameter.
Note:
This operation only works when an enterprise user store such as Windows domain or LDAP has been configured using the Update Identity Store operation. This operation does not search SAML identity providers.
Request parameters
| Parameter | Details |
|---|---|
| filter | An optional parameter to narrow the user search. Example |
| maxCount | The maximum number of records that the client is willing to accept. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample request URL for searchEnterpriseUsers:
POST /webadaptor/portaladmin/security/users/searchEnterpriseUsers HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
filter=john&maxCount=1000&f=jsonJSON Response syntax
{
"users": [
{
"username": "<username>",
"description": "<description>",
"fullname": "<fullname>",
"email": "<email>"
},
...
]
"hasMore": <true|false>
}JSON Response example
{
"users": [
{
"username": "domain\\jdoe0001",
"description": "CN=jdoe,OU=Users,OU=Support Group,OU=Departments,DC=domain,DC=com",
"fullname": "John Doe",
"email": "[email protected]"
},
{
"username": "DOMAIN\\aturing",
"description": "Software Product Development",
"fullname": "Alan Turing",
"email": "[email protected]"
}
],
"hasMore": false
}