Skip to main content
POST
Create User

Authorizations

X-API-Key
string
header
required

Body

application/json
email
string
required
display_name
string | null
tenant_role
string | null

Tenant role id or name; defaults to Base. Any other needs org:admin

workspaces
WorkspaceAssignment · object[]

Workspace roles other than Runner need org:admin. Without any, the user joins the fallback workspace

metadata
Metadata · object | null
send_invite
boolean
default:false

Response

Successful Response

id
string
required
email
string
required
tenant_admin
boolean
required
is_active
boolean
required
status
enum<string>
required
Available options:
active,
pending,
suspended
display_name
string | null
tenant_role_id
string | null
tenant_role
string | null
metadata
Metadata · object
memberships
Membership · object[]