- URL:
- https://<root>/security/users/getUsers
- Methods:
POST
- Required Capability:
- Access allowed with any authorized privilege
- Version Introduced:
- 10.1
Description
The get
operation returns a pageable view of users in the user store. It is intended for iterating over all available user accounts. To search for specific user accounts instead, use the Search Users operation.
Request parameters
Parameter | Description |
---|---|
| The starting index (zero-based) from the users list that must be returned in the result page. The default is 0. Example
|
| The maximum number of user accounts to return in the result page. The default size is 10. The Example
|
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the get
operation, which seeks to return 20 users starting from the 10th position:
POST /webadaptor/admin/security/users/getUsers HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
startIndex=9&pageSize=20&f=json
JSON Response syntax
{
"users": [<user1>, <user2>],
"hasMore": <true|false>
}