List available roles
Returns the list of available roles in the system for the organization. This includes both organization-level roles (e.g., org_admin, org_member) and zone-level roles (e.g., zone_manager, zone_viewer).
Each role includes:
- name: Internal identifier (e.g., org_admin, zone_manager)
- label: Human-readable display name (e.g., Organization Administrator)
- scope: Whether the role applies at organization or zone level
Path parameters
Organization ID or label identifier
Organization ID or label
Query parameters
The scope at which a role can be assigned.
- organization: Roles that apply at the organization level (e.g., org_admin)
- zone: Roles that apply at the zone level (e.g., zone_manager)
Filter roles by scope (organization or zone level)
Fields to expand in the response. Supports "permissions" to include the permissions field with the caller's permissions for the resource. For list organization identities only, "total_count" populates pagination.total_count with the number of identities matching the same filters as the list (excluding cursor and limit). Other operations ignore expand values they do not use.
Headers
Unique request identifier specified by the originating caller and passed along by proxies.
Response
List of available roles
Example response
{
"items": [
{
"name": "org_admin",
"label": "Organization Administrator",
"description": "Full administrative access to all organization resources"
}
],
"permissions": {
"organizations": {
"read": true,
"update": true
},
"users": {
"read": true,
"list": true
}
}
}