Zscaler Private Access V1 SDK

This article outlines the Zscaler Python SDK resources you can use to manage Zscaler Private Access (ZPA) features programmatically, with code examples.

Quick Start

import zssdk

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

# Access Zscaler Private Access service
zpa = session.zpa

Available Resources

Access individual resources using the has pattern:

Resource	Description
CloudConnectorGroup	Cloud Connector Group resource
Idp	Idp resource
PraConsole	Pra Console resource
PrivilegedCredential	Privileged Credential resource
ACLClassPermissionGroup	A C L Class Permission Group resource
ConfigOverride	Config Override resource
CurrentSessionDetails	Current Session Details resource
PostureProfile	Posture Profile resource
Microtenant	Microtenant resource
UserPortal	User Portal resource
InspectionCustomControl	Inspection Custom Control resource
AppConnectorGroup	App Connector Group resource
SCIMGroup	S C I M Group resource
ApiKeyDetail	Api Key Detail resource
PrivateCloudController	Private Cloud Controller resource
...	27 more resources

Collections

List resources using the hasMany pattern:

Collection	Resource Type
cloud_connector_groups	CloudConnectorGroup
pra_consoles	PraConsole
privileged_credentials	PrivilegedCredential
all_version_profiles_visible_by_customer_ids	VersionProfile
ACL_class_permission_groups	ACLClassPermissionGroup
config_overrides	ConfigOverride
all_microtenants_summaries	NameId
microtenants	Microtenant
all_user_portal_links	UserPortalLink
user_portal_aups	UserPortalAUP
user_portals	UserPortal
all_scim_attribute_values	string
all_inspection_controls	InspectionPredefinedControlResource
all_versions_for_predefined_inspection_controls	string
inspection_control_action_types	string

Example: CRUD Operations

import zssdk

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

# Create
resource = session.zpa.CloudConnectorGroup()
resource.name = "value"
resource.create()

# Read
resource = session.zpa.CloudConnectorGroup(id=resource.id)
resource.load()
print(resource.name)

# Update
resource.name = "Updated value"
resource.update()

# Delete
resource.delete()

Example: List Resources

# List all resources
for item in session.zpa.cloud_connector_groups():
    print(f"{item.id}: {item.name}")