{
"code": "rate_limited",
"message": "You've exceeded the API rate limit. Try again later."
}
Authorizations
Authorization
string
header
required
Scopes
read
write
Path Parameters
customRoleKey
string<string>
required
The custom role key or ID
Response
Custom role response
_id
string
required
The ID of the custom role
Example:
"1234a56b7c89d012345e678f"
_links
object
required
The location and content type of related resources
Show child attributes
key
string
required
The key of the custom role
Example:
"example-custom-role"
name
string
required
The name of the custom role
Example:
"Example custom role"
policy
object[]
required
An array of the policies that comprise this custom role
Show child attributes
_access
object
Details on the allowed and denied actions for this custom role
Show child attributes
description
string
The description of the custom role
Example:
"This custom role is just an example"
basePermissions
string
When this field is omitted, reader is stored, and it grants read access across every project in addition to the policy. A value of no_access grants only what the policy allows.
Example:
"reader"
resourceCategory
string
The category of resources this role is intended to manage. Can be organization, project, or any. Once set, this field cannot be changed.
assignedTo
object
The number of teams and members this role is assigned to
Show child attributes
_presetBundleVersion
integer
If created from a preset, the preset bundle version
_presetStatements
object[]
If created from a preset, the read-only statements copied from the preset