v1

latestOpenAPI 3.0.02026-07-17493090.2 KB

Roles

Permissions

RBAC

Authorization

Fetches a list of roles

This endpoint can be used to view all of the available roles configured for the node. These roles control access to various permissions in the system.

This endpoint requires the permission "authorization.rbac.read".

get/authorization/roles

Query parameters

offsetinteger

paging offset

limitinteger

maximum number of items to return (max 100)

Headers

Authorizationstring required

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersioninteger

Example:2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Response

Successfully retrieved the requested list of roles

Example response

{
  "data": [
    {
      "role_id": "circuit-administrator",
      "display_name": "Circuit Administrator"
    }
  ],
  "paging": {
    "current": "/registry/nodes?offset=10&limit=10",
    "offset": 10,
    "limit": 10,
    "total": 50,
    "first": "/registry/nodes?offset=0&limit=10",
    "prev": "/registry/nodes?offset=0&limit=10",
    "next": "/registry/nodes?offset=20&limit=10",
    "last": "/registry/nodes?offset=40&limit=10"
  }
}