CAcargill
Roles
Permissions
RBAC
Authorization

Add a role

Changed on

This endpoint can be used to add a new role to the Splinter Role-based authorization system. The role must conform to the role schema and have unique "role_id" value.

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

post/authorization/roles

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/authorization/roles
  • 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.

Request body

role_idstring

Unique identifier for the role

display_namestring

A human readable name of the role.

permissionsstring[]

An array of permissions included with this role.

Example request

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

Response

The role was successfully added

Changes