Skip to main content
POST
Create a user

Authorizations

X-Qanapi-Authorization
string
header
required

A machine credential, qk_ followed by its secret. Only a hash of the secret is stored, so a key is displayed exactly once, when it is created or rotated. A key reaches only the configurations it is linked to.

It may also be sent as Authorization: Bearer qk_..., which is recognised by the prefix.

Body

application/json
email
string<email>
required

Trimmed and lowercased before it is stored, and unique across accounts.

password
string<password>
required
Required string length: 12 - 1024
name
string
role
enum<string>
default:user
Available options:
admin,
user

Response

The new user.

id
string<uuid>
required
email
string<email>
required
name
string | null
required
role
enum<string>
required

admin is the only role that reaches user, policy and API key management without an explicit policy statement.

Available options:
admin,
user
created_at
string<date-time>
required
updated_at
string<date-time>
required