Update custom role

PATCH
/api/v2/roles/:customRoleKey

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

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

_accessobjectOptional

Details on the allowed and denied actions for this custom role

descriptionstringOptional

The description of the custom role

basePermissionsstringOptional

Base permissions to use for this role. Only applicable to roles created prior to October 2024.

resourceCategorystringOptional

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

assignedToobjectOptional

The number of teams and members this role is assigned to

Errors

Built with