User invites / List
List active user invites
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/user_invites/list
Method: GET
Authorisation: Minimum role: ADMIN
Request Arguments
Name | Type | Source |
---|
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_user_invite[]
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_user_invite
Name | Type | ReadOnly | Description |
---|---|---|---|
groups | DTO_reference[] | Groups | |
id | Int32 | ReadOnly | Id |
String | |||
tenant_role | ENUM tenant_user_role | Tenant role | |
expires_date | DateTime | ReadOnly | Expires date |
expires_relative | String | ReadOnly | Expires relative |
DTO_reference
Name | Type | ReadOnly | Description |
---|---|---|---|
id | Int32 | The id of the reference | |
label | Object | ReadOnly | Name/Label from referenced object. |
ENUM tenant_user_role
Value | Name | Description |
---|---|---|
0 | UNKNOWN | UNKNOWN |
1 | OWNER | Owner |
2 | ADMIN | Admin |
3 | USER | User |