Request
This endpoint expects an object.
namestringRequired
A human-friendly name for the custom role
keystringRequired
The custom role key
policylist of objectsRequired
Resource statements for custom role
descriptionstringOptional
Description of custom role
basePermissionsstringOptional
Base permissions to use for this role. Defaults to no_access (older roles defaulted to reader). Recommended to set this to no_access in all cases.
resourceCategorystringOptional
The category of resources this role is intended to manage. Can be organization, project, or any. This field is immutable.
Response
Custom role response
_idstring
The ID of the custom role
_linksmap from strings to objects
The location and content type of related resources
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
Details on the allowed and denied actions for this custom role
descriptionstring
The description of the custom role
basePermissionsstring
Base permissions to use for this role. Defaults to no_access (older roles defaulted to reader). Recommended to set this to no_access in all cases.
resourceCategorystring
The category of resources this role is intended to manage. Can be organization, project, or any. Once set, this field cannot be changed.
assignedToobject
The number of teams and members this role is assigned to
_presetBundleVersioninteger
If created from a preset, the preset bundle version
_presetStatementslist of objects
If created from a preset, the read-only statements copied from the preset
