Create custom role
Create a new custom role
Headers
Authorization
Request
This endpoint expects an object.
name
A human-friendly name for the custom role
key
The custom role key
policy
Resource statements for custom role
description
Description of custom role
basePermissions
Base permissions to use for this role. Only applicable to roles created prior to October 2024.
resourceCategory
The category of resources this role is intended to manage. Can be organization
, project
, or any
. This field is immutable.
Response
Custom role response
_id
The ID of the custom role
_links
The location and content type of related resources
key
The key of the custom role
name
The name of the custom role
policy
An array of the policies that comprise this custom role
_access
Details on the allowed and denied actions for this custom role
description
The description of the custom role
basePermissions
Base permissions to use for this role. Only applicable to roles created prior to October 2024.
resourceCategory
The category of resources this role is intended to manage. Can be organization
, project
, or any
. Once set, this field cannot be changed.
assignedTo
The number of teams and members this role is assigned to
_presetBundleVersion
If created from a preset, the preset bundle version
_presetStatements
If created from a preset, the read-only statements copied from the preset