roles

List

Every role in the catalog, built-in and custom — roles are a global table with no tenant_id, so this is not tenant-scoped. Gated on tenant_read or above; see also listRoles (GET /roles), the same underlying data exposed to ANY authenticated caller with no admin gate, for populating a role picker. total counts the roles matching q; an unknown sort falls back to slug.

get/admin/roles

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/admin/roles
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

qstring

case-insensitive substring of slug, name or description

sort'slug' | 'name' | 'created' | 'updated'

sort field

sort_dir'asc' | 'desc'

sort direction (id breaks ties in the same direction)

limitinteger

page size

offsetinteger

page offset

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.