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

No input arguments
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
NameTypeReadOnlyDescription
groupsDTO_reference[]Groups
idInt32ReadOnlyId
emailStringEmail
tenant_roleENUM tenant_user_roleTenant role
expires_dateDateTimeReadOnlyExpires date
expires_relativeStringReadOnlyExpires relative
DTO_reference
NameTypeReadOnlyDescription
idInt32The id of the reference
labelObjectReadOnlyName/Label from referenced object.
ENUM tenant_user_role
ValueNameDescription
0UNKNOWNUNKNOWN
1OWNEROwner
2ADMINAdmin
3USERUser