CAcargill
Authorization
Permissions

GET /authorization/permissions

Changed on

Fetches the list of all REST API permissions

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

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/authorization/permissions
  • Auth
    none declared. Required headers: Authorization

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 list of REST API permissions

Example response

{
  "data": [
    {
      "permission_id": "circuit.read",
      "permission_display_name": "Circuit read",
      "permission_description": "Allows the client to modify circuit state"
    }
  ]
}

Changes

  • b189e44dea24Revision changes
    • breaking

      the / response's property type changed from to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d94c21748719Revision changes
    • info

      endpoint added