Skip to main content

List Users

Get a paginated list of all users with optional search functionality.

Query Parameters

limit
integer
default:"20"
Number of users to return per page (1-100)
offset
integer
default:"0"
Number of users to skip for pagination
Search query to filter users by email or other fields

Response

users
array
Array of user objects
total
integer
Total number of users matching the query
limit
integer
Number of users returned per page
offset
integer
Number of users skipped
has_more
boolean
Whether there are more users to fetch

Update User

Update a user’s status and role.

Path Parameters

user_id
uuid
required
The user ID to update

Body Parameters

is_active
boolean
required
Whether the user account should be active
role_id
uuid
required
The role ID to assign to the user

Response

message
string
Confirmation message

Delete User

Permanently delete a user from the system.

Path Parameters

user_id
uuid
required
The user ID to delete

Response

message
string
Confirmation message

Get User Roles

Get all roles assigned to a specific user.

Path Parameters

user_id
uuid
required
The user ID to query

Response

status
string
Response status
user_id
string
The user ID as a string
roles
array
Array of assigned roles

Replace User Roles

Replace all roles for a user with a new set of roles.

Path Parameters

user_id
uuid
required
The user ID to update

Body Parameters

role_ids
array
required
Array of role UUIDs to assign to the user

Response

status
string
Response status
message
string
Confirmation message
roles
array
Array of assigned roles

Add Role to User

Assign a single role to a user.

Path Parameters

user_id
uuid
required
The user ID to update

Body Parameters

role_id
uuid
required
The role UUID to assign

Response

status
string
Response status
message
string
Confirmation message (“Role assigned” or “Role already assigned”)

Remove Role from User

Remove a specific role from a user.

Path Parameters

user_id
uuid
required
The user ID to update
role_id
uuid
required
The role ID to remove

Response

status
string
Response status
message
string
Confirmation message

Get User Direct Permissions

Get all permissions directly assigned to a user (bypassing roles).

Path Parameters

user_id
uuid
required
The user ID to query

Response

user_id
uuid
The user identifier
direct_permissions
array
Array of directly assigned permissions

Update User Direct Permissions

Replace all direct permissions for a user.

Path Parameters

user_id
uuid
required
The user ID to update

Body Parameters

permission_ids
array
required
Array of permission UUIDs to assign directly to the user

Response

Same as Get User Direct Permissions.

Add Direct Permission to User

Assign a permission directly to a user.

Path Parameters

user_id
uuid
required
The user ID to update

Body Parameters

permission_id
uuid
required
The permission UUID to assign

Response

status
string
Response status
message
string
Confirmation message

Remove Direct Permission from User

Remove a direct permission from a user.

Path Parameters

user_id
uuid
required
The user ID to update
permission_id
uuid
required
The permission ID to remove

Response

status
string
Response status
message
string
Confirmation message

Get User Direct Permission Sets

Get all permission sets directly assigned to a user (bypassing roles).

Path Parameters

user_id
uuid
required
The user ID to query

Response

user_id
uuid
The user identifier
direct_permission_sets
array
Array of directly assigned permission sets

Update User Direct Permission Sets

Replace all direct permission sets for a user.

Path Parameters

user_id
uuid
required
The user ID to update

Body Parameters

permission_set_ids
array
required
Array of permission set UUIDs to assign directly to the user

Response

Same as Get User Direct Permission Sets.

Add Direct Permission Set to User

Assign a permission set directly to a user.

Path Parameters

user_id
uuid
required
The user ID to update

Body Parameters

permission_set_id
uuid
required
The permission set UUID to assign

Response

status
string
Response status
message
string
Confirmation message

Remove Direct Permission Set from User

Remove a direct permission set from a user.

Path Parameters

user_id
uuid
required
The user ID to update
permission_set_id
uuid
required
The permission set ID to remove

Response

status
string
Response status
message
string
Confirmation message

Get User Effective Permissions

Get user’s effective permissions with breakdown by source (roles, direct sets, direct permissions).

Path Parameters

user_id
uuid
required
The user ID to query

Response

user_id
uuid
The user identifier
from_roles
array
Permissions inherited from roles
from_direct_sets
array
Permissions from directly assigned permission sets
from_direct_permissions
array
Directly assigned permissions
effective
array
Combined effective permissions (union of all sources)

Get User RBAC History

Get all RBAC changes related to a specific user.

Path Parameters

user_id
uuid
required
The user ID to query

Query Parameters

limit
integer
default:"50"
Number of history entries to return (1-100)
offset
integer
default:"0"
Number of entries to skip for pagination

Response

status
string
Response status
user_id
string
The user ID as a string
history
array
Array of RBAC change events

Build docs developers (and LLMs) love