HTTP - Management
List users
Created by s.yearsley, last modified by r.saunders on 12 Feb 2021
User resources can be retrieved as a paged list and ordered by either username.
GET/api/security/users/?order={order}&q={q}&pageIndex={pageIndex}&pageSize={pageSize}
Parameters
| Name | Parameter type | Type | Format | Description | Example |
|---|---|---|---|---|---|
| pageIndex | query | number | integer | The index of the page | |
| pageSize | query | number | integer | The number of results per page. The default is 25. | |
| order | query | string | A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order. | -version.modified |
Example
Get the first page of 5 users that contain the word tyler in their key properties.
GET: /api/security/users?q=tyler&pageSize=5Responses
| HTTP status code | Reason | Model |
|---|---|---|
| 200 | Success | PagedList<User> |
| 403 | Forbidden | Error |
| 500 | Internal server error | Error |
| 401 | Unauthorized | Error |