SegmentGroup

Segment Group resource for Zscaler Private Access.

Resource operations

This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments.

Quick Start

import zssdk
import logging

# Enable debug logging for SegmentGroup
logging.getLogger('zssdk.zpa').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)

session = zssdk.Session(
    vanity_domain="your-vanity-domain",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# Get a specific SegmentGroup
resource = session.zpa.SegmentGroup(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers

Name	Type	Description
id	string	Unique identifier

Actions

create()

Creates a new SegmentGroup. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
customer_id	long	No	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
restriction_type	string	No	-
description	string	No	-
enabled	boolean	No	-
applications	ApplicationBaseWrapperCollection	No	-
policy_migrated	boolean	No	-
config_space	string	No	-
tcp_keep_alive_enabled	integer	No	-
application_names	NameIdWrapperCollection	No	-
shared_microtenant_ids	int64Collection	No	-
read_only	boolean	No	-
zscaler_managed	boolean	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.SegmentGroup()
resource.name = "example-name"
resource.create()
print(f"Created with ID: {resource.id}")

delete()

Deletes a SegmentGroup by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.zpa.SegmentGroup(id="your-resource-id")
resource.delete()

load()

Fetches an existing SegmentGroup by id. Only the id identifier is required; load() takes no other arguments.

Returns: SegmentGroup

Example:

resource = session.zpa.SegmentGroup(id="your-resource-id")
resource.load()
print(resource.name)

update()

Updates an existing SegmentGroup. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
customer_id	long	No	-
microtenant_id	long	No	-
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_name	string	No	-
restriction_type	string	No	-
description	string	No	-
enabled	boolean	No	-
applications	ApplicationBaseWrapperCollection	No	-
policy_migrated	boolean	No	-
config_space	string	No	-
tcp_keep_alive_enabled	integer	No	-
application_names	NameIdWrapperCollection	No	-
shared_microtenant_ids	int64Collection	No	-
read_only	boolean	No	-
zscaler_managed	boolean	No	-
name_without_trim	string	No	-

Example:

resource = session.zpa.SegmentGroup(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	long	No	-
name	string	Yes	-
microtenant_id	long	No	-
microtenant_name	string	No	-
restriction_type	string	No	-
description	string	No	-
enabled	boolean	No	-
applications	ApplicationBaseWrapperCollection	No	-
policy_migrated	boolean	No	-
config_space	string	No	-
tcp_keep_alive_enabled	integer	No	-
application_names	NameIdWrapperCollection	No	-
shared_microtenant_ids	int64Collection	No	-
read_only	boolean	No	-
zscaler_managed	boolean	No	-
name_without_trim	string	No	-

Related

• SegmentGroup - Data structure definition
• Logging guide - enable verbose logs while debugging this resource