Types

InternalUserCreate

The body that invites an internal user.

emailrequired
string (email)
The internal user's email. At most 53 characters, so the sign-in username with its invite suffix fits 64. A user, invite or contact email that holds it, in any case, returns 422 `unique`.
titlerequired
string
Title, such as Mr, Ms or Dr.
first_namerequired
string
The internal user's first name.
last_namerequired
string
The internal user's last name.
sso_id
string | null
The internal user's single sign-on id. When set, the user is created `active` and no invite email is sent.
external_id
string | null
The internal user's id in your own system.
role_ids
integer[]
Ids of the roles to grant: your own organisation's or global roles, never service roles, else 422 `exists` naming `role_ids.N`. A role carrying the super-admin permission needs a super-admin caller, else 403 `missing_permission`.
roles
integer[]
Deprecated alias of `role_ids`, accepted until 2027-06-30 with `Deprecation` and `Sunset` headers. `role_ids` wins when both are sent.

Used by (1)