OverviewCustom roles

Update custom role

Update a single custom role. Updating a custom role uses a JSON patch or JSON merge patch representation of the desired changes. To learn more, read Updates.

To add an element to the policy array, set the path to /policy and then append /<array index>. Use /0 to add to the beginning of the array. Use /- to add to the end of the array.

Path parameters

customRoleKeystringRequired
The custom role key

Headers

AuthorizationstringRequired

Request

This endpoint expects an object.
patchlist of objectsRequired
A JSON patch representation of the change to make
commentstringOptional
Optional comment

Response

Custom role response
_idstring
The ID of the custom role
keystring
The key of the custom role
namestring
The name of the custom role
policylist of objects
An array of the policies that comprise this custom role
_accessobject or null
Details on the allowed and denied actions for this custom role
descriptionstring or null
The description of the custom role
basePermissionsstring or null
Base permissions to use for this role. Only applicable to roles created prior to October 2024.
resourceCategorystring or null

The category of resources this role is intended to manage. Can be organization, project, or any. Once set, this field cannot be changed.

assignedToobject or null
The number of teams and members this role is assigned to
_presetBundleVersioninteger or null
If created from a preset, the preset bundle version
_presetStatementslist of objects or null

If created from a preset, the read-only statements copied from the preset

Errors