v56

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014121451.1 MB

Roles

Update a custom role

Update a custom role in Comp AI. Create custom roles and resolve permission sets for organization-level access control.

patch/v1/roles/{roleId}

Path parameters

roleIdstring required

Example:rol_abc123

Role ID

Request body

namestring

New name for the custom role

permissionsobject

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

obligationsobject

Updated obligations for the role.

Example request

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

Response

Role updated successfully

idstring

namestring

permissionsobject

isBuiltInboolean

createdAtstring date-time

updatedAtstring date-time