list
Gets list of users.
Request
HTTP Request
GET /user
Parameters
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| login | No | string | Filter by user login |
| loginPattern | No | string | Filter by user login pattern |
| role | No | integer | Filter by user role. 0 is Administrator, 1 is Client. |
| status | No | integer | Filter by user status. 0 is Active, 1 is Locked Out, 2 is Disabled. |
| sortField | No | string | Result list sort field. Available values are ID and Login. |
| sortOrder | No | string | Result list sort order. Available values are ASC and DESC. |
| take | No | integer | Number of records to take from the result list. |
| skip | No | integer | Number of records to skip from the result list. |
Authorization
Access JSON Web Token (ManageUser)
Request Body
Do not supply a request body with this method.
Response
If successful, this method returns array of User resources in the response body.
| Property Name | Type | Description |
|---|---|---|
| id | integer | User identifier. |
| login | string | User login using during authentication. |
| role | integer | User role. Available values: 0: Administrator role 1: Client role |
| status | integer | User status. Available values: 0: The user is active 1: The user has been locked out due to invalid login attempts 2: The user has been disabled |
| lastLogin | datetime | User last login timestamp (UTC). |
| data | object | User data, a JSON object with an arbitrary structure. |
| introReviewed | boolean | Indicates if user reviewed an intro. |
Updated less than a minute ago