Skip to main content
logoTetrate Service BridgeVersion: next

Segmentation Service

APIs to configure Segmentation Ruless and policies

Segmentation​

The Segmentation service provides methods to configure segmentation policies and rules.

CreateSegmentationPolicy​

GetSegmentationPolicy​

UpdateSegmentationPolicy​

ListSegmentationPolicies​

DeleteSegmentationPolicy​

CreateSegmentationMembership​

GetSegmentationMembership​

UpdateSegmentationMembership​

ListSegmentationMemberships​

DeleteSegmentationMembership​

CreateSegmentationRules​

GetSegmentationRules​

UpdateSegmentationRules​

ListSegmentationRules​

DeleteSegmentationRules​

CreateSegmentationMembershipRequest​

Request to create a segmentation membership.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the segmentation membership will be created. This is the FQN of the organization.

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])?$
}

membership

tetrateio.api.tsb.segmentation.v1.SegmentationMembership
REQUIRED
Details of the segmentation membership to be created.

message = {
  required: true
}

CreateSegmentationPolicyRequest​

Request to create a segmentation policy.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the segmentation policy will be created. This is the FQN of the organization.

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])?$
}

policy

tetrateio.api.tsb.segmentation.v1.SegmentationPolicy
REQUIRED
Details of the segmentation policy to be created.

message = {
  required: true
}

CreateSegmentationRulesRequest​

Request to create Segmentation Rules.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Segmentation Rules will be created. This is the FQN of the organization.

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])?$
}

rules

tetrateio.api.tsb.segmentation.v1.SegmentationRules
REQUIRED
Details of the Segmentation Rules to be created.

message = {
  required: true
}

DeleteSegmentationMembershipRequest​

Request to delete a segmentation membership.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the segmentation membership.

string = {
  min_len: 1
}

DeleteSegmentationPolicyRequest​

Request to delete a segmentation policy.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the segmentation policy.

string = {
  min_len: 1
}

DeleteSegmentationRulesRequest​

Request to delete a Segmentation Rules.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Segmentation Rules.

string = {
  min_len: 1
}

GetSegmentationMembershipRequest​

Request to retrieve a segmentation membership.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the segmentation membership.

string = {
  min_len: 1
}

GetSegmentationPolicyRequest​

Request to retrieve a segmentation policy.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the segmentation policy.

string = {
  min_len: 1
}

GetSegmentationRulesRequest​

Request to retrieve Segmentation Rules.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Segmentation Rules.

string = {
  min_len: 1
}

ListSegmentationMembershipsRequest​

Request to list segmentation memberships.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list segmentation memberships from. This is the FQN of the organization.

string = {
  min_len: 1
}

ListSegmentationMembershipsResponse​

List of segmentation membershipss that are registered in the platform.

FieldDescriptionValidation Rule

memberships

List of tetrateio.api.tsb.segmentation.v1.SegmentationMembership
The list of segmentation membershipss that are registered in the platform.

–

ListSegmentationPoliciesRequest​

Request to list segmentation policies.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list segmentation policies from. This is the FQN of the organization.

string = {
  min_len: 1
}

ListSegmentationPoliciesResponse​

List of segmentation policies that are registered in the platform.

FieldDescriptionValidation Rule

policies

List of tetrateio.api.tsb.segmentation.v1.SegmentationPolicy
The list of segmentation policies that are registered in the platform.

–

ListSegmentationRulesRequest​

Request to list Segmentation Rules.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Segmentation Rules from. This is the FQN of the organization.

string = {
  min_len: 1
}

ListSegmentationRulesResponse​

List of Segmentation Rules that are registered in the platform.

FieldDescriptionValidation Rule

rules

List of tetrateio.api.tsb.segmentation.v1.SegmentationRules
The list of Segmentation Rules that are registered in the platform.

–