Get Users

URL:: https://<root>/security/users/getUsers
Methods:: POST
Required Capability:: Access allowed with any authorized privilege
Version Introduced:: 10.1

Description

The getUsers 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

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 Use dark colors for code blocksCopy `1 startIndex=9`
`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 Use dark colors for code blocksCopy `1 pageSize=20`
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

startIndex

The starting index (zero-based) from the users list that must be returned in the result page. The default is 0.

Example
Use dark colors for code blocksCopy
startIndex=9

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
Use dark colors for code blocksCopy
pageSize=20

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the getUsers operation, which seeks to return 20 users starting from the 10th position:

Use dark colors for code blocksCopy
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

Use dark colors for code blocksCopy
{
  "users": [<user1>, <user2>],
  "hasMore": <true|false>
}