zscaler-api-talkers 6.3.1

Unofficial Zscaler API python SDK for ZIA, ZPA and Zscaler Client Connector

Unofficial Zscaler API talkers

API Talkers

ZIA API Talker

Python classes to leverage Zscaler Internet Access API

ZPA API Talker

Python classes to leverage Zscaler Private Access API

Client Connector API Talker

A Python class to leverage Zscaler Client Connector API. (Currently in Beta status.)

The Client Connector API talker is accessed via the Class object named: ClientConnectorTalker

ZDX API Talker

A Python class to leverage Zscaler Digital Experience API. (Currently in development.)

This class interacts with ZDX via the URLs presented in the Portal (aka, the ZDX configuration website). It is named: ZdxPortalTalker

Cloud and Branch Connector API Talker

A Python class to leverage Cloud and Branch Connector API. (Currently in development.)

This class interacts with the Cloud and Branch Connector Portal. The class object is named CloudConnectorTalker (https://help.zscaler.com/cloud-branch-connector/about-zscaler-cloud-branch-connector-api)

Installation

Option 1: Run in a Python Virtual Environment

1. Create a virtual Environment: python3 -m venv .zs_api_talkers
2. Activate virtual environment:
   • Linux: source .zs_api_talkers/bin/activate
   • Windows: .\.zs_api_talkers\Scripts\activate
3. Install Zscaler API talkers: pip install zscaler-api-talkers

Option 2: Run within a Docker Container

We provide two methods to build a Docker container. Either using the code hosted on GitHub or the code published to PyPi.

PyPi Method

1. Download Dockerfile
   • Linux: curl -O https://raw.githubusercontent.com/sergitopereira/zscaler_api_talkers/sergiodevelop/Dockerfile
   • Windows: wget -O Dockerfile https://raw.githubusercontent.com/sergitopereira/zscaler_api_talkers/sergiodevelop/Dockerfile
2. Build Image and Run Container
   1. docker build -t zscaler_api_talkers .
   2. docker run -it zscaler_api_talkers bash
3. Usage (program is in /zscaler_api_talkers/)
   • cd zscaler_api_talkers

GitHub Method

1. Download Dockerfile
   • Linux: curl -O https://raw.githubusercontent.com/sergitopereira/zscaler_api_talkers/sergiodevelop/git_version.Dockerfile
   • Windows: wget -O Dockerfile https://raw.githubusercontent.com/sergitopereira/zscaler_api_talkers/sergiodevelop/git_version.Dockerfile
2. Build Image and Run Container
   1. docker build -f git_version.Dockerfile -t zscaler_api_talkers .
   2. docker run -it zscaler_api_talkers bash
3. Usage (program is in /zscaler_api_talkers/)
   • cd zscaler_api_talkers

Zscaler Secure Internet and SaaS Access SDK

Usage ZiaTalker

from zscaler_api_talkers import ZiaTalker
zia=ZiaTalker('<Zscaler Cloud Name>')
zia.authenticate(api_key='API_KEY', username='USERNAME', password='PASSWORD')
zia.list_url_categories()
zia.list_users()
# To view all methods available
print(dir(zia))

Usage ZiaTalker with OAUTH2.0

from zscaler_api_talkers import ZiaTalker
zia=ZiaTalker('<Zscaler Cloud Name>', '<Bear oauth2.0 token>')
zia.list_url_categories()
zia.list_users()
# To view all methods available
print(dir(a))

Zscaler Secure Private Access SDK

Usage ZpaTalker

from zscaler_api_talkers import ZpaTalker
a=ZpaTalker('customerID')
a.authenticate(client_id='clientID',client_secret='clientSecret')
# To view all methods available
print(dir(a))

Zscaler Client Connector SDK

Usage ClientConnectorTalker

from zscaler_api_talkers import ClientConnectorTalker
a=ClientConnectorTalker('<Zscaler Cloud Name>')    
a.authenticate(clientid='clientID',secretkey='clientSecret')
a.list_devices('companyID')
a.list_OTP('companyID','user device id')
# To view all methods available
print(dir(a))

Zscaler Cloud & Branch Connector SDK

Usage CloudConnectorTalker

from zscaler_api_talkers import CloudConnectorTalker
bac=CloudConnectorTalker(cloud_name='<ZScaler Cloud Name>', api_key='API_KEY', username='USERNAME', password='PASSWORD')
bac.list_cloud_branch_connector_groups()
bac.delete_cloud_branch_connector_vm(group_id='GROUPID', vm_id='VMID')
print(dir(bac))

Usage examples

• https://github.com/sergitopereira/zscaler_api_talkers#usage-example
• https://github.com/sergitopereira/zscaler_api_talkers/blob/main/example.py

Bugs and enhancements

Feel free to open an issues using GitHub Issues

Author

Sergio Pereira: Zscaler Professional Services