v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Permissions

List all permissions

Retrieves a comprehensive, paginated list of all permissions available within the environment. Use this endpoint to view all permission definitions for auditing, role management, or understanding the complete set of available access controls. The response includes pagination tokens to navigate through large sets of permissions efficiently. Each permission object contains the permission name, description, creation time, and last update time. This operation is useful for building permission selection interfaces, auditing permission usage, or understanding the scope of available access controls in your RBAC system.

get/api/v1/permissions

Query parameters

page_tokenstring

Page token to retrieve next page of results

page_sizeinteger

Number of permissions to return per page (max 100)

type'SCALEKIT' | 'ENVIRONMENT'

Filter permissions by type: ALL, SCALEKIT, or ENVIRONMENT, where SCALEKIT are predefined Scalekit permissions and ENVIRONMENT are custom permissions created in the environment, default is ALL

Response

Successfully retrieved the list of permissions. Returns a paginated list of permission objects with metadata and pagination tokens for navigation.

next_page_tokenstring

Token to retrieve next page of results

prev_page_tokenstring

Token to retrieve previous page of results

total_sizeinteger

Total number of permissions available

Example response

{
  "next_page_token": "token_def456",
  "permissions": [
    {
      "is_scalekit_permission": true
    }
  ],
  "prev_page_token": "token_def456",
  "total_size": 150
}