v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01144108427.9 KB
Authorization

List Roles

List roles. Open to authenticated users so the UI can populate dropdowns.

Paginated via limit / offset so a single call cannot return the entire catalog of roles + their permissions. Stable order is (name, id) so offset is deterministic across calls.

get/api/v1/authz/roles

Query parameters

is_systemboolean nullable

Filter by is_system flag

Filter by is_system flag

namestring nullable

Substring match on role name

Substring match on role name

limitinteger
offsetinteger

Response

Successful Response

created_atstring date-time required
created_bystring uuid nullable required
descriptionstring nullable required
idstring uuid required
is_systemboolean required
namestring required
parent_role_idstring uuid nullable required
permissionsstring[] required
updated_atstring date-time required
workspace_idstring uuid nullable required