Sign in
users

Create User

Create a new user. Requires System Admin.

If a user with the same email already exists globally but is not in the current tenant, they are added to the tenant instead of being rejected.

post/api/v1/users

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

usernamestring required
emailstring email required
passwordstring required
first_namestring nullable
last_namestring nullable
rolestring nullable

Legacy free-text role (deprecated)

user_role_idinteger nullable

FK to user_roles table

is_activeboolean
is_adminboolean
custom_fieldsobject nullable

Per-tenant custom field values

Response

Successful Response

idinteger required
usernamestring required
emailstring required
first_namestring nullable
last_namestring nullable
rolestring nullable
user_role_idinteger nullable
user_role_namestring nullable
is_activeboolean required
is_adminboolean
last_loginstring date-time nullable
custom_fieldsobject

Changes

No recorded changes to this endpoint across all 5 revisions of this API.