- URL:
- https://<root>/security/users/searchEnterpriseUsers
- Methods:
POST- Required Capability:
- Access allowed with either the "Security and Infrastructure" or "Add" privileges
- Version Introduced:
- 10.3
Description
The search operation searches users in the configured enterprise user store. You can narrow down the search using the filter parameter.
Request parameters
| Parameter | Details |
|---|---|
| An optional parameter to narrow the user search. Example |
| The maximum number of records that the client is willing to accept. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the search operation:
POST /<context>/portaladmin/security/users/searchEnterpriseUsers HTTP/1.1
Host: organization.example.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": "jdoe@domain.com"
},
{
"username": "DOMAIN\\aturing",
"description": "Software Product Development",
"fullname": "Alan Turing",
"email": "aturing@email.com"
}
],
"hasMore": false
}