Authorization

List Roles

Changed on

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

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Query parameters

is_systemboolean nullable

Filter by is_system flag

namestring nullable

Substring match on role name

exact_namestring nullable

Exact 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

Changes