- URL:https://<users-url>/getUsers(POST only)
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.1
Description
This operation gives you 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 |
|---|---|
| startIndex | The starting index (zero-based) from the users list that must be returned in the result page. The default is 0. Example |
| pageSize | The maximum number of user accounts to return in the result page. The default size is 10. The pageSize is also governed by the underlying implementation of the user store. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample POST request for getUsers 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=jsonJSON Response syntax
{
"users": [<user1>, <user2>],
"hasMore": <true|false>
}