v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Permissions

Create new permission

Creates a new permission that represents a specific action users can perform within the environment. Use this endpoint to define granular access controls for your RBAC system. You can provide a unique permission name following the format 'action:resource' (for example, 'read:documents', 'write:users') and an optional description explaining the permission's purpose. The permission name must be unique across the environment and follows alphanumeric naming conventions with colons and underscores. Returns the created permission object including system-generated ID and timestamps.

post/api/v1/permissions

Request body

descriptionstring

Description of the permission

namestring

Unique name/ID of the permission. Must be 1–64 characters using only letters, numbers, underscores (_), and colons (:).

Example request

{
  "description": "Allows user to read documents from the system",
  "name": "read:documents"
}

Response

Permission created successfully. Returns the complete permission object with system-generated ID, name, description, and timestamps.

Example response

{
  "permission": {
    "is_scalekit_permission": true
  }
}