Skip to main content
PATCH
Update 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.

Path Parameters

id
string<uuid>
required

The user's id.

Body

application/json

Every field is optional, and one that is absent is left alone rather than cleared.

email
string<email>
name
string
password
string<password>
Required string length: 12 - 1024
role
enum<string>

Requires user:manage, and may never be changed on your own account.

Available options:
admin,
user
current_password
string<password>

Required when changing the password or email address on your own account, and ignored when an administrator changes somebody else's.

Response

Updated.

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