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

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

Unique identifier of the role to retrieve

Response

200 - application/json

The role was successfully retrieved

Extends the base Role type to include a unique identifier

​
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