Roles
List roles
Returns roles for the caller's organization. By default only org-scoped roles are returned. Pass include=cluster to also include cluster-wide roles (those with organizationId == null, e.g. super-admin and other system-actor roles); these are not assignable from the org UI but downstream consumers like the auth-context role lookup and the events page need them to resolve cluster-wide role IDs.
get/roles
Request
- Base URLhttps://api.voltairlabs.com
- Auth
- HTTP bearer
- or API key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
include'cluster'
Set to cluster to additionally include cluster-wide roles (organizationId == null). Omit for org-scoped roles only.
limitinteger
Page size (default 50, max 200)
cursorstring
Opaque pagination cursor from a previous response
Response
Success
Changes
No recorded changes to this operation across all 5 revisions of this API.