Skip to main content
POST
Create a custom role

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
name
string
required

Name of the custom role

Required string length: 2 - 50
Example:

"Compliance Lead"

permissions
object
required

Permissions for the role. Keys are resource names, values are arrays of allowed actions.

Example:
obligations
object

Obligations for the role. Boolean flags for requirements like compliance.

Example:

Response

Role created successfully

id
string
Example:

"rol_abc123"

name
string
Example:

"compliance-lead"

permissions
object
isBuiltIn
boolean
Example:

false

createdAt
string<date-time>
updatedAt
string<date-time>