Skip to main content
Version: 1.3.x

Security Service

Security

The Security service provides methods to manage security settings in TSB.

It provides methods to create and manage security groups within a workspace, allowing to create fine-grained groupings to configure a subset of the workspace namespaces. Access policies can be assigned at group level, providing a fine-grained access control to the security configuration features.

The Security service also provides methods to configure the different security settings that are allowed within each group.

CreateGroup

Requires CreateGroup

Create a new security group in the given workspace.

Groups will by default configure all the namespaces owned by their workspace, unless explicitly configured. If a specific set of namespaces is set for the group, it must be a subset of the namespaces defined by its workspace.

GetGroup

Requires ReadGroup

Get the details of the given security group.

UpdateGroup

Requires WriteGroup

Modify a security group.

ListGroups

List all security groups in the given workspace.

DeleteGroup

Requires DeleteGroup

Delete the given security group. Note that deleting resources in TSB is a recursive operation. Deleting a security group will delete all configuration objects that exist in it.

CreateSettings

Requires CreateSecuritySetting

Create a security settings object in the security group.

GetSettings

Requires ReadSecuritySetting

Get the details of the given security settings object.

UpdateSettings

Requires WriteSecuritySetting

Modify the given security settings object.

ListSettings

List all security settings objects that have been attached to the security group.

DeleteSettings

Requires DeleteSecuritySetting

Delete the given security settings from the group.

CreateSecurityGroupRequest

Request to create a Security Group.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Group will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

group

tetrateio.api.tsb.security.v2.Group
REQUIRED
Details of the Group to be created.

message = {
  required: true
}

CreateSecuritySettingsRequest

Request to create a Security Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Security Settings will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
}

settings

tetrateio.api.tsb.security.v2.SecuritySetting
REQUIRED
Details of the Security Settings to be created.

message = {
  required: true
}

DeleteSecurityGroupRequest

Request to delete a Security Group.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Group.

string = {
  min_len: 1
}

DeleteSecuritySettingsRequest

Request to delete a Security Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Security Settings.

string = {
  min_len: 1
}

GetSecurityGroupRequest

Request to retrieve a Security Group.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Group.

string = {
  min_len: 1
}

GetSecuritySettingsRequest

Request to retrieve a Security Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Security Settings.

string = {
  min_len: 1
}

ListSecurityGroupsRequest

Request to list Security Groups.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Groups from.

string = {
  min_len: 1
}

ListSecurityGroupsResponse

List of all security groups in the workspace.

FieldDescriptionValidation Rule

groups

List of tetrateio.api.tsb.security.v2.Group

ListSecuritySettingsRequest

Request to list Security Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Security Settings from.

string = {
  min_len: 1
}

ListSecuritySettingsResponse

List of all security settings objects attached to the group.

FieldDescriptionValidation Rule

settings

List of tetrateio.api.tsb.security.v2.SecuritySetting