Skip to main content
POST
Create a user

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Body

application/json
name
string
required

User's name.

Maximum string length: 255
email
string<email>
required

User's email address.

Maximum string length: 255
password
string
required

User's password.

Minimum string length: 8
password_confirmation
string
required

User's password confirmation. Must match the password field.

Minimum string length: 8
phone
string | null

User's phone number.

Maximum string length: 20
title
string | null

User's title.

Maximum string length: 255
emergency_contact_name
string | null

User's emergency contact name.

Maximum string length: 255
emergency_contact_surname
string | null

User's emergency contact surname.

Maximum string length: 255
emergency_contact_phone_number
string | null

User's emergency contact phone number.

Maximum string length: 20
blood_group
string | null

User's blood group.

Maximum string length: 10
language
string[] | null

User's language preferences.

avatar_url
string | null

User's avatar URL.

Maximum string length: 1000
is_active
boolean | null

User's active status.

bio
string | null

User's bio.

Maximum string length: 1000
role_ids
integer[] | null

Role identifiers to assign to user.

A role ID.

Response

success
string
required
data
UserResource · object
required