Skip to main content
PATCH
Update a classification

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
required

The classification's id, or its slug. Either resolves.

Example:

"top-secret"

Body

application/json

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

name
string
slug
string
description
string

Response

Updated.

id
string<uuid>
required
name
string
required
slug
string
required

How policy statements and X-Qanapi-Classification name this label.

description
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
users
object[]

Users holding this clearance directly. Present on the list and fetch responses; absent after a create or an update.

roles
object[]

Roles whose members hold this clearance. Present on the list and fetch responses; absent after a create or an update.