Users / User_ only aggregates
Returns unique values to be used in filter input.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/users/aggregate
Method: GET
Authorisation: Minimum role: USER
Request Arguments
| Name | Type | Source |
|---|---|---|
| field_keys | String[] | Query |
| filter | DTO_standard_filter | Query |
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_user[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| sort_by_key | String | Sort by key | |
| response_field_keys | String[] | Only return the fields specified | |
| filters | String[] | Each string needs to be structured: filters=field_key:operator:value1|value2|value3 Only used to store filters for passing along as querystring | |
| include_aggregations | Boolean | Include aggregations | |
| include_imported | Boolean | Include imported | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
DTO_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| tenant_user | DTO_tenant_user | Tenant user | |
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| language | DTO_translation_language | ReadOnly | Language |
| id | Int32 | ReadOnly | Id |
| String | |||
| given_name | String | Given name | |
| family_name | String | Family name | |
| full_name | String | ReadOnly | Name |
| profile_pic | String | ReadOnly | Profile pic |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
| display_absolute_time | Boolean | ReadOnly | Display absolute time |
DTO_tenant_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| groups | DTO_reference_is_admin[] | Groups | |
| id | Int32 | ReadOnly | Id |
| tenant_id | Int32 | Tenant id | |
| user_id | Int32 | User id | |
| role | ENUM tenant_user_role | Role | |
| status | ENUM tenant_user_status | Status | |
| last_seen | DateTime | Last seen |
DTO_reference_is_admin
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| is_admin | Boolean | ReadOnly | Is admin |
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
DTO_translation_language
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id | Int32 | ReadOnly | Leave empty on input |
| name | String | Name | |
| code | String | Code | |
| icon | String | ReadOnly | Icon |
| icon_sqare | String | ReadOnly | Icon sqare |
ENUM tenant_user_role
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | OWNER | Owner |
| 2 | ADMIN | Admin |
| 3 | USER | User |
ENUM tenant_user_status
| Value | Name | Description |
|---|---|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | ACTIVE | ACTIVE |
| 2 | DEACTIVE | DEACTIVE |
ENUM sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
