Skip to main content
GET
/
rbac
/
roles
List all roles
curl --request GET \
  --url https://api.axiom.co/v2/rbac/roles \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "<string>",
    "id": "<string>",
    "datasetCapabilities": {},
    "description": "<string>",
    "members": [
      "<string>"
    ],
    "orgCapabilities": {
      "annotations": [],
      "apiTokens": [],
      "auditLog": [],
      "billing": [],
      "dashboards": [],
      "datasets": [],
      "endpoints": [],
      "flows": [],
      "integrations": [],
      "monitors": [],
      "notifiers": [],
      "rbac": [],
      "sharedAccessKeys": [],
      "users": [],
      "views": []
    },
    "viewCapabilities": {}
  }
]

Authorizations

​
Authorization
string
header
required

Authenticate using an API token or personal access token (PAT). Include the token as a Bearer token: Authorization: Bearer <token>. For more information, see Tokens.

Response

200 - application/json

A list of roles was successfully retrieved

​
name
string
required

Unique name identifier for the role

​
id
string
required

Unique identifier for the role

​
datasetCapabilities
object

Defines the available permissions for dataset operations

​
description
string

Detailed description of the role's purpose and scope

​
members
string[]

List of user IDs that are assigned to this role

​
orgCapabilities
object

Defines organization-wide permissions and capabilities

​
viewCapabilities
object

Defines the available permissions for view operations