Skip to main content
PATCH
Update user

Authorizations

X-Qanapi-Authorization
string
header
required

A machine credential, qk_ followed by its secret. The first twelve characters are an indexed prefix; the rest is compared in constant time against a stored SHA-256 hash. 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

Body

application/json
email
string<email>
name
string
password
string<password>
Minimum string length: 12
role
enum<string>
Available options:
admin,
user
current_password
string<password>

Required when changing your own password or email. An administrator may not change their own role at all.

Response

Updated.

id
string<uuid>
required
email
string<email>
required
role
enum<string>
required
Available options:
admin,
user
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string | null