Skip to main content
POST
Create a User

Authorizations

Authorization
string
header
required

Bearer token

Headers

X-Account-ID
string<uuid>
required

Account ID

Body

application/json
email
string<email>
required

User email address

Maximum string length: 255
role
enum<string>
required

User role

Available options:
system_admin,
system_support,
admin,
support,
viewer,
organization_viewer
organization_scopes
(string<uuid> | enum<string>)[]
required

Array of organization IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

initial_license
enum<string>

Apply this user license in the creation transaction before sending an invitation; omitted preserves the account default

Available options:
free,
standard,
unlicensed
first_name
string

User first name

Required string length: 1 - 100
last_name
string

User last name

Required string length: 1 - 100
account_scopes
(string<uuid> | enum<string>)[]

Array of account IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

Response

Default Response

id
string<uuid>
required

User unique identifier

account_id
string<uuid>
required

Account ID this user belongs to

email
string<email>
required

User email address

role
enum<string>
required

User role

Available options:
system_admin,
system_support,
admin,
support,
viewer,
organization_viewer
account_scopes
(string<uuid> | enum<string>)[]
required

Array of account IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

organization_scopes
(string<uuid> | enum<string>)[]
required

Array of organization IDs the user has access to (or "*" for wildcard access)

UUID or wildcard "*"

first_name
string | null

User first name

last_name
string | null

User last name

external_ids
object

External system ID mappings

navigation_profile_id
string | null
read-only
metadata
object
read-only

System-recorded, read-only details. Only included with expand=metadata, which requires permission to create users.

created_at
string<date-time>

User creation timestamp

updated_at
string<date-time>

Last update timestamp

created_by
string

User ID who created this user

updated_by
string

User ID who last updated this user

deleted_at
string<date-time> | null

Deletion timestamp