Skip to main content
Version: 1.2.x

Role Service

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

Requires CreateRole

Create a new role.

ListRoles

List all existing roles.

GetRole

Requires ReadRole

Get the details of the given role.

UpdateRole

Requires WriteRole

Modify a role.

DeleteRole

Requires DeleteRole

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

CreateRoleRequest

Request to create a Role.

FieldDescriptionValidation 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.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Role.

string = {
  min_len: 1
}

GetRoleRequest

Request to retrieve a Role.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Role.

string = {
  min_len: 1
}

ListRolesRequest

Request to list Roles.

NameNumberDescription

ListRolesResponse

List of all existing roles.

FieldDescriptionValidation Rule

roles

List of tetrateio.api.tsb.rbac.v2.Role