ClickStack: List Roles | ClickHouse Docs

GET/v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

ClickStack: Retrieves all roles for the authenticated team, including predefined roles.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the ClickStack service.

format: uuid

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalarray ofobject
7 properties
- idstringrequired
  Role ID.
  
  Example: "507f1f77bcf86cd799439011"
- namestringrequired
  Role name.
  
  Example: "Read Only"
- permissionsarray ofobjectrequired
  The CASL permissions granted by this role.
  
  5 properties
  actionstringrequired
  The action this permission grants or denies.
  
  Example: "read"
  subjectstringrequired
  The resource the action applies to.
  
  Example: "dashboard"
  invertedoptionalboolean
  When true, the rule denies rather than grants the action.
  
  Example: false
  integrationoptionalstring
  The integration the permission is scoped to.
  
  Example: "mongodb"
  conditionsoptionalobject
- isPredefinedbooleanrequired
  Whether this is an immutable predefined/system role.
  
  Example: false
- descriptionoptionalstring
  Human-readable role description.
  
  Example: "Read-only access to all resources"
- createdAtoptionalstring
  Creation timestamp.
  
  format: date-time
  Example: "2025-01-01T00:00:00.000Z"
- updatedAtoptionalstring
  Last update timestamp.
  
  format: date-time
  Example: "2025-06-15T10:30:00.000Z"

ClickStack: List Roles

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/roles \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/roles';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/roles"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Read Only",
      "description": "Read-only access to all resources",
      "permissions": [
        {
          "action": "read",
          "subject": "dashboard",
          "inverted": false,
          "integration": "mongodb",
          "conditions": {}
        }
      ],
      "isPredefined": false,
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-06-15T10:30:00.000Z"
    }
  ]
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}