Skip to main content

List All Permissions

List all system-defined permissions.

Response

permissions
array
Array of permission objects

List Permission Categories

Get all permission categories for organizing permissions.

Response

categories
array
Array of category strings

Get My Permissions

Get the current user’s effective permissions.

Response

user_id
uuid
The current user’s identifier
permissions
array
Array of permission codes the user has access to

List Permission Sets

List all permission sets with their associated permissions.

Response

permission_sets
array
Array of permission set objects

Create Permission Set

Create a new permission set with a collection of permissions.

Body Parameters

code
string
required
Unique code for the permission set
name
string
required
Human-readable name for the permission set
description
string
Description of what this permission set grants
permission_codes
array
required
Array of permission codes to include in this set (e.g., [“user.view”, “user.edit”])

Response

Same as individual permission set in List Permission Sets.

Get Permission Set

Get a specific permission set by ID.

Path Parameters

id
uuid
required
The permission set ID to retrieve

Response

Same as individual permission set in List Permission Sets.

Update Permission Set

Update an existing permission set.

Path Parameters

id
uuid
required
The permission set ID to update

Body Parameters

name
string
New name for the permission set
description
string
New description for the permission set
permission_codes
array
Array of permission codes to replace existing permissions

Response

Same as individual permission set in List Permission Sets.

Delete Permission Set

Delete a permission set from the system.

Path Parameters

id
uuid
required
The permission set ID to delete

Response

Returns 204 No Content on success.

List RBAC Audit Logs

List RBAC audit logs with optional filters for tracking permission changes.

Query Parameters

entity_type
string
Filter by entity type (e.g., “user”, “role”, “permission”)
entity_id
uuid
Filter by specific entity ID
action
string
Filter by action type
limit
integer
default:"50"
Number of logs to return (1-100)
offset
integer
default:"0"
Number of logs to skip for pagination

Response

audit_logs
array
Array of audit log entries
total
integer
Total number of audit logs
limit
integer
Number of logs returned
offset
integer
Number of logs skipped

Get RBAC Entity History

Get complete audit history for a specific RBAC entity.

Path Parameters

entity_type
string
required
The type of entity (e.g., “user”, “role”, “permission”)
entity_id
uuid
required
The entity ID to retrieve history for

Query Parameters

secondary_entity_id
uuid
Filter by secondary entity ID for relationship changes

Response

status
string
Response status
entity_type
string
The entity type queried
entity_id
string
The entity ID as a string
history
array
Array of change events

Build docs developers (and LLMs) love