Skip to main content
PATCH
Update a role by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API key. Must only be used when using Hanko Cloud.

Path Parameters

id
string<uuid4>
required

ID of the role

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

Body

application/json

Patch payload for updating a role.

Omitted properties are not changed.

name
string

The new display name of the role. Must be non-empty (after trimming whitespace) and at most 255 characters.

Maximum string length: 255

Response

Details about the role

id
string<uuid4>
required

The ID of the role

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

slug
string
required

Machine-safe, human-readable identifier for the role. Immutable after creation.

name
string
required

Display name of the role

created_at
string<date-time>
required

Time of creation of the role

updated_at
string<date-time>
required

Time of last update of the role