- URL:
- https://<root>/security/users/search
- Methods:
POST- Required Capability:
- Access allowed with any authorized privilege
- Version Introduced:
- 10.1
Description
The search operation searches for a specific user, or a group of users, from the user store. The size of the search result can be controlled with the max parameter.
Request parameters
| Parameter | Description |
|---|---|
| A filter string to search the users. Example |
| The maximum number of users that will be returned. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the search operation that seeks to return the first 20 users whose usernames start with 'john':
POST /webadaptor/admin/security/users/search HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
filter=john&maxCount=20&f=jsonJSON Response syntax
{
"users": [<user1>, <user2>],
"hasMore": <true|false>
}JSON Response example
{
"users": [johnDoe, johnDern],
"hasMore": false
}