Skip to main content
GET
List the Trust Fabric role catalog
Roles belong to the platform, so the catalog is decided at the deployment root: your role grants must hold grants:read at the platform scope or the deployment root org unit, or the call is 403 permission_denied with error.requiredPermission: "grants:read". Only system roles are listed; compatibility roles (one per migrated credential) are never listed. To give or revoke a role, call giveRole or revokeRole, which need grants:manage. See Roles and grants. See also listRoleDefinitions, which lists every role, system and custom, with what it contains, under roles:read alone.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:200

Items per page, 1 to 200 (default 200); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 200
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Role catalog

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.