Role Service

import { PanelContent, PanelContentCode, } from “@theme/Panel”;

Service to manage access roles in Service Bridge.

RBAC

The RBAC service provides methods to manage the roles in the Service Bridge platform. It provides method to configure the roles that can be used in the management plane access control policies and their permissions.

CreateRole

rpc CreateRole (tetrateio.api.tsb.rbac.v2.CreateRoleRequest) returns (tetrateio.api.tsb.rbac.v2.Role)

Requires CREATE

Create a new role.

ListRoles

rpc ListRoles (tetrateio.api.tsb.rbac.v2.ListRolesRequest) returns (tetrateio.api.tsb.rbac.v2.ListRolesResponse)

Requires READ

List all existing roles.

GetRole

rpc GetRole (tetrateio.api.tsb.rbac.v2.GetRoleRequest) returns (tetrateio.api.tsb.rbac.v2.Role)

Requires READ

Get the details of the given role.

UpdateRole

rpc UpdateRole (tetrateio.api.tsb.rbac.v2.Role) returns (tetrateio.api.tsb.rbac.v2.Role)

Requires WRITE

Modify a role.

DeleteRole

rpc DeleteRole (tetrateio.api.tsb.rbac.v2.DeleteRoleRequest) returns (google.protobuf.Empty)

Requires DELETE

Delete a role. NRoles that are in use by policies attached to existing resources cannot be deleted.

CreateRoleRequest

Request to create a Role.

Field	Description	Validation Rule
name	string REQUIRED The short name for the resource to be created.	string = {   min_len: 1 }
role	tetrateio.api.tsb.rbac.v2.Role REQUIRED Details of the Role to be created.	message = {   required: true }

DeleteRoleRequest

Request to delete a Role.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Role.	string = {   min_len: 1 }

GetRoleRequest

Request to retrieve a Role.

Field	Description	Validation Rule
fqn	string REQUIRED Fully-qualified name of the Role.	string = {   min_len: 1 }

ListRolesResponse

List of all existing roles.

Field	Description	Validation Rule
roles	List of tetrateio.api.tsb.rbac.v2.Role	–