Client Connector SDK

This article outlines the Zscaler Python SDK resources you can use to manage Client Connector 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 Client Connector service
zcc = session.zcc

Available Resources

Access individual resources using the has pattern:

Resource	Description
PredefinedIPBasedApplication	Predefined I P Based Application resource
ApplicationProfile	Application Profile resource
ProcessBasedApplication	Process Based Application resource
TrustedNetwork	Trusted Network resource
PrivacyInfo	Privacy Info resource
UserPassword	User Password resource
CustomIPBasedApplication	Custom I P Based Application resource
DeviceOtp	Device Otp resource
AdminRole	Admin Role resource
AdminUser	Admin User resource
WebFailOpenPolicy	Web Fail Open Policy resource
WebForwardingProfile	Web Forwarding Profile resource
AppServiceContract	App Service Contract resource

Collections

List resources using the hasMany pattern:

Collection	Resource Type
web_policies	Record
predefined_IP_based_applications	PredefinedIPBasedApplication
application_profiles	ApplicationProfile
process_based_applications	ProcessBasedApplication
trusted_networks	TrustedNetwork
custom_IP_based_applications	CustomIPBasedApplication
devices	DeviceList
admin_roles	AdminRole
admin_users	AdminUser
fail_open_policies	WebFailOpenPolicy
web_forwarding_profiles	WebForwardingProfile
app_service_contracts	AppServiceContract

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.zcc.PredefinedIPBasedApplication()
resource.uid = "value"
resource.create()

# Read
resource = session.zcc.PredefinedIPBasedApplication(id=resource.id)
resource.load()
print(resource.uid)

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

# Delete
resource.delete()

Example: List Resources

# List all resources
for item in session.zcc.web_policies():
    print(f"{item.id}: {item.uid}")