Update obligations for a built-in role | Comp AI API

Override the obligations for a built-in role (e.g., turn off the compliance obligation for owners). Permissions stay sourced from the hardcoded defaults.

PATCH /v1/roles/built-in/{name}/obligations

Update obligations for a built-in role

cURL

curl --request PATCH \
  --url https://api.trycomp.ai/v1/roles/built-in/{name}/obligations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "obligations": {
    "compliance": false
  }
}
'

200

{
  "name": "<string>",
  "obligations": {
    "compliance": true
  }
}

Authorizations

apikeyoauth2

X-API-Key · string · header · required

API key for authentication

Path Parameters

name · string · required

Built-in role name

Example:

"owner"

Body

application/json

obligations · object · required

Obligations override for the built-in role.

Show child attributes

Example:

{ "compliance": false }

Response

200

application/json

Obligations updated

name · string

obligations · object

Show child attributes