CAcargill
Roles

Fetches a role by its ID

Changed on

This endpoint can be used to view a specific role.

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

get/authorization/roles/{role_id}

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/authorization/roles/{role_id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

role_idstring required

ID of the role to fetch

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 role

Example response

{
  "data": {
    "role_id": "circuit-administrator",
    "display_name": "Circuit Administrator"
  }
}

Changes