Skip to main content
logoTetrate Service BridgeVersion: next

Security Service

Service to manage security settings.

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​

GetGroup​

UpdateGroup​

ListGroups​

DeleteGroup​

CreateSettings​

GetSettings​

UpdateSettings​

ListSettings​

DeleteSettings​

CreateServiceSecuritySettings​

GetServiceSecuritySettings​

UpdateServiceSecuritySettings​

ListServiceSecuritySettings​

DeleteServiceSecuritySettings​

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
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

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
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

settings

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

message = {
  required: true
}

CreateServiceSecuritySettingsRequest #​

Request to create a Service Security Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Service 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
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

settings

tetrateio.api.tsb.security.v2.ServiceSecuritySetting
REQUIRED
Details of the Service 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
}

force

bool
Force the deletion of the object even if deletion protection is enabled. If this is set, then the object and all its children will be deleted even if any of them has the deletion protection enabled.

–

DeleteSecuritySettingsRequest #​

Request to delete a Security Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Security Settings.

string = {
  min_len: 1
}

DeleteServiceSecuritySettingsRequest #​

Request to delete a Service Security Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Service 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
}

GetServiceSecuritySettingsRequest #​

Request to retrieve a Service Security Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Service 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

–

ListServiceSecuritySettingsRequest #​

Request to list Service Security Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Service Security Settings from.

string = {
  min_len: 1
}

ListServiceSecuritySettingsResponse #​

List of all Service Security Settings objects attached to the group.

FieldDescriptionValidation Rule

settings

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

–