User invites / Create

Invite user(s) to tenant

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/user_invites/create

Method: POST

Authorisation: Minimum role: ADMIN

Request Arguments
Name Type Source
inputDTO_invite_usersBody

  Request body example

Response object

Response status: 200 (OK)

Response type: Boolean

Wrapper: DTO_response_wrap_get_many

Other response statuses: 400 (BadRequest), 403 (Forbidden)

  Response body example

DTO_invite_users
NameTypeReadOnlyDescription
emailsString[]Emails
group_idsInt32[]Group ids
tenant_roleENUM tenant_user_roleTenant role
ENUM tenant_user_role
ValueNameDescription
0UNKNOWNUNKNOWN
1OWNEROwner
2ADMINAdmin
3USERUser

left_arrow POST Users / Activate deactivate

GET User invites / List right_arrow