Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Bearer authentication. Send Authorization: Bearer .

Body

application/json

Role Input

RoleInput payload

displayName
string
required

Role's display name.

Example:

"Custom Editor"

name
string
required

Role's unique identifier name.

Example:

"custom-editor"

description
string

Role's description.

Example:

"A custom editor role"

Response

Created

RoleResponse payload

createdAt
string
Example:

"2026-06-24T10:00:00.000Z"

description
string
Example:

"A custom editor role"

groups
string[]
id
string
Example:

"custom-editor"

isEnabled
boolean
Example:

true

isSystem
boolean

Whether the role is a platform-managed system role, immutable through this API. Never omitempty: false must travel so a consumer does not read a missing key as "not a system role".

Example:

false

name
string
Example:

"Custom Editor"

roles
string[]
users
string[]