Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Body

application/json
name
string
required
Required string length: 1 - 200
principal
string

OS account the user is identified by; must be unique. Absent for someone added ahead of time, who signs in with pulze.io as their email

Required string length: 1 - 320
alias
string | null
Maximum string length: 200
first_name
string | null
Maximum string length: 200
last_name
string | null
Maximum string length: 200
role
string | null
Maximum string length: 64
email
string | null
Maximum string length: 320
avatar
string | null
Maximum string length: 2000
group_id
string | null
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Response

The created user

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

principal
string
required

OS account the user is identified by

name
string
required
alias
string | null
required
first_name
string | null
required
last_name
string | null
required
role
string | null
required
email
string | null
required
avatar
string | null
required
group_id
string | null
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

created_at
integer
default:0
required
Example:

1785846207000

updated_at
integer
default:0
required
Example:

1785846207000

signin_required
boolean

They sign in with pulze.io, as the account with their email, before RenderFlow lets them in

signed_in_from
string[]

The OS accounts they are signed in at now, as each login's principal. Listed by GET /users only