v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Permissions

Retrieve permission details

Retrieves complete information for a specific permission by its unique name identifier. Use this endpoint to view permission details including description, creation time, and last update time. Provide the permission name in the path parameter following the format 'action:resource' (for example, 'read:documents'). This operation is useful for auditing permission definitions, understanding permission purposes, or verifying permission existence before assignment. Returns the complete permission object with all metadata and system-generated timestamps.

get/api/v1/permissions/{permission_name}

Path parameters

permission_namestring required

Name of the permission

Response

Successfully retrieved permission details. Returns the complete permission object including name, description, creation time, and update time.

Example response

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