Sign in
Roles

Create a custom role

Create a new custom role with specified permissions. Only admins and owners can create roles.

post/v1/roles

Request body

namestring required

Name of the custom role

permissionsobject required

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

obligationsobject

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

Example request

{
  "name": "Compliance Lead",
  "permissions": {
    "control": [
      "read",
      "update"
    ],
    "policy": [
      "read",
      "update"
    ],
    "risk": [
      "read"
    ]
  },
  "obligations": {
    "compliance": true
  }
}

Response

Role created successfully

idstring
namestring
permissionsobject
isBuiltInboolean
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "rol_abc123",
  "name": "compliance-lead"
}

Changes