Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB
User

Create a user

Create a user in the caller's (or specified) tenant and send a confirmation email.

post/users/

Query parameters

cookie_namestring nullable
tenant_idinteger

Request body

first_namestring required

User's given name.

last_namestring required

User's family name.

emailstring email required

Email address used to log in; must be unique.

passwordstring required

Initial password; the user is prompted to change it on first login.

adminboolean nullable

Whether the user has tenant administrator privileges.

superadminboolean nullable

Whether the user is a platform operator; requires superadmin to set.

tenant_idinteger nullable

Tenant to create the user in; defaults to the caller's tenant.

Example request

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "password": "S3cure-P@ssw0rd!",
  "tenant_id": 1
}

Response

Successful Response

idinteger required

Unique identifier of the user.

created_atstring date-time required

UTC timestamp when the user was created.

emailstring email required

Current confirmed email address.

email_confirmedboolean required

Whether the email address has been confirmed.

pending_emailstring nullable

New email awaiting confirmation, or null if none pending.

namestring nullable

Full display name, if set.

first_namestring nullable

User's given name.

last_namestring nullable

User's family name.

adminboolean required

Whether the user has tenant administrator privileges.

superadminboolean nullable

Whether the user is a platform operator.

activeboolean required

Whether the account is active and can authenticate.

tenant_idinteger nullable

Identifier of the tenant the user belongs to.

Example response

{
  "id": 42,
  "created_at": "2026-01-15T09:30:00Z",
  "email": "jane.doe@example.com",
  "email_confirmed": true,
  "pending_email": "jane.new@example.com",
  "name": "Jane Doe",
  "first_name": "Jane",
  "last_name": "Doe",
  "active": true,
  "tenant_id": 1
}