Skip to content

Create a user

POST
/api/v1/users

Requires the admin role.

There is no open registration and no account creation. terms_of_service must be passed explicitly — prefer POST /api/v1/invitations so the person accepts the terms and sets their own password. The created user receives a confirmation email and cannot sign in until they confirm the address.

Media typeapplication/json
object
user
object
email
required
string format: email
password
required
string format: password
first_name
string
last_name
string
role
string
default: viewer
Allowed values: admin member viewer
terms_of_service
required
string

201

The created member

Response body
Media typeapplication/json
object
id
string
email
string format: email
name
string
first_name
string
last_name
string
role
string
Allowed values: admin member viewer
roles
Array<string>
owner
boolean

True for the account owner

created_at
string format: date-time

When the membership was created

updated_at
string format: date-time

403

Insufficient scope, role, or credits

Response body
Media typeapplication/json
object
error
object
code
string

A stable machine-readable code

message
string
details
Array<string>

Present on validation errors; one entry per failed validation

422

The record could not be saved

Response body
Media typeapplication/json
object
error
object
code
string

A stable machine-readable code

message
string
details
Array<string>

Present on validation errors; one entry per failed validation