Skip to main content
GET
/
v1
/
roles
/
permissions
List role permission options
curl --request GET \
  --url https://api.coderabbit.ai/v1/roles/permissions \
  --header 'x-coderabbitai-api-key: <api-key>'
{
  "resource_ids": [
    "repository_management",
    "user_management",
    "role_management"
  ],
  "access_types": [
    "read",
    "write",
    "delete"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt

Use this file to discover all available pages before exploring further.

Lists the valid resource_id and access_type values that can be used when creating or updating Enterprise custom roles. For more information, see Role-based access.

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Response

200 - application/json

Successfully retrieved role permission options

resource_ids
string[]
required
Example:
[
"repository_management",
"user_management",
"role_management"
]
access_types
enum<string>[]
required
Available options:
read,
write,
delete
Example:
["read", "write", "delete"]