3.0.0 (January 20, 2025) - BREAKING CHANGES

Notes

• Golang: v1.23

Zscaler OneAPI Support

PR #293: Added support for OneAPI Oauth2 authentication support through Zidentity.

NOTES

• Starting at v3.0.0 version this SDK provides dual API client functionality and is backwards compatible with the legacy Zscaler API framework.
• The new OneAPI framework is compatible only with the following products ZCC/ZIA/ZPA.
• The following products ZCON - Cloud Connector and ZDX and Zscaler Digital Experience, authentication methods remain unnaffected.

Refer to the README page for details on client instantiation, and authentication requirements on each individual product.

PR #293: All API clients now support Config Setter object ZCC/ZCON/ZDX/ZIA/ZPA
PR #293: Added Ability to pass context to each method that is sent into the request.

ZCC New Endpoints

PR #293 - Added the following new ZCC API Endpoints:

• Added GET /downloadServiceStatus to download service status for all devices.
• Added GET /getDeviceCleanupInfo to retrieve device cleanup information.
• Added PUT /setDeviceCleanupInfo to cleanup device information.
• Added GET /getDeviceDetails to retrieve device detailed information.
• Added GET /getAdminUsers to retrieve mobile portal admin user.
• Added PUT /editAdminUser to update mobile portal admin user.
• Added GET /getAdminUsersSyncInfo to retrieve mobile portal admin user sync information.
• Added POST /syncZiaZdxAdminUsers to retrieve mobile portal admin users ZIA and ZDX sync information.
• Added POST /syncZpaAdminUsers to retrieve mobile portal admin users ZPA sync information.
• Added GET /getAdminRoles to retrieve mobile portal admin roles.
• Added GET /getCompanyInfo to retrieve company information.
• Added GET /getZdxGroupEntitlements to retrieve ZDX Group entitlement enablement.
• Added PUT /updateZdxGroupEntitlement to retrieve ZDX Group entitlement enablement.
• Added GET /updateZpaGroupEntitlement to retrieve ZPA Group entitlement enablement.
• Added GET /web/policy/listByCompany to retrieve Web Policy By Company ID.
• Added PUT /web/policy/activate to activate mobile portal web policy
• Added PUT /web/policy/edit to update mobile portal web policy
• Added DELETE /web/policy/{policyId}/delete to delete mobile portal web policy.
• Added GET /webAppService/listByCompany to retrieve Web App Service information By Company ID.
• Added GET /webFailOpenPolicy/listByCompany to retrieve web Fail Open Policy information By Company ID.
• Added PUT /webFailOpenPolicy/edit to update mobile portal web Fail Open Policy.
• Added GET /webForwardingProfile/listByCompany to retrieve Web Forwarding Profile information By Company ID.
• Added POST /webForwardingProfile/edit to create a Web Forwarding Profile.
• Added DELETE /webForwardingProfile/{profileId}/delete to delete Web Forwarding Profile.
• Added GET /webTrustedNetwork/listByCompany to retrieve multiple Web Trusted Network information By Company ID.
• Added POST /webTrustedNetwork/edit to create Web Trusted Network resource.
• Added PUT /webTrustedNetwork/edit to update Web Trusted Network resource.
• Added DELETE /webTrustedNetwork/{networkId}/delete to delete Web Trusted Network resource.
• Added GET /getWebPrivacyInfo to retrieve Web Privacy Info.
• Added GET /setWebPrivacyInfo to update Web Privacy Info.

ZIA Sandbox Submission - BREAKING CHANGES

PR #293 - Authentication to Zscaler Sandbox now use the following attributes during client instantiation.

• sandboxToken - Can also be sourced from the ZSCALER_SANDBOX_TOKEN environment variable.
• sandboxCloud - Can also be sourced from the ZSCALER_SANDBOX_CLOUD environment variable.

NOTE The previous ZIA_SANDBOX_TOKEN has been deprecated.

ZIA Sandbox Rules

PR #293 - Added the following new ZIA API Endpoints:

• Added GET /sandboxRules to retrieve the list of all Sandbox policy rules.
• Added GET /sandboxRules/{ruleId} to retrieve the Sandbox policy rule information based on the specified ID.
• Added POST /sandboxRules to add a Sandbox policy rule.
• Added PUT /sandboxRules/{ruleId} to update the Sandbox policy rule configuration for the specified ID.
• Added DELETE /sandboxRules/{ruleId} to delete the Sandbox policy rule based on the specified ID.

ZIA DNS Control Rules

PR #293 - Added the following new ZIA API Endpoints:

• Added GET /firewallDnsRules to retrieve the list of all DNS Control policy rules.
• Added GET /firewallDnsRules/{ruleId} to retrieve the DNS Control policy rule information based on the specified ID.
• Added POST /firewallDnsRules to add a DNS Control policy rules.
• Added PUT /firewallDnsRules/{ruleId} to update the DNS Control policy rule configuration for the specified ID.
• Added DELETE /firewallDnsRules/{ruleId} to delete the DNS Control policy rule based on the specified ID.

ZIA IPS Control Rules

PR #293 - Added the following new ZIA API Endpoints:

• Added GET /firewallIpsRules to retrieve the list of all IPS Control policy rules.
• Added GET /firewallIpsRules/{ruleId} to retrieve the IPS Control policy rule information based on the specified ID.
• Added POST /firewallIpsRules to add a IPS Control policy rule.
• Added PUT /firewallIpsRules/{ruleId} to update the IPS Control policy rule configuration for the specified ID.
• Added DELETE /firewallIpsRules/{ruleId} to delete the IPS Control policy rule based on the specified ID.

ZIA File Type Control Policy

PR #293 - Added the following new ZIA API Endpoints:

• Added GET /fileTypeRules to retrieve the list of all File Type Control policy rules.
• Added GET /fileTypeRules/lite to retrieve the list of all File Type Control policy rules.
• Added GET /fileTypeRules/{ruleId} to retrieve the File Type Control policy rule information based on the specified ID.
• Added POST /fileTypeRules to add a File Type Control policy rule.
• Added PUT /fileTypeRules/{ruleId} to update the File Type Control policy rule configuration for the specified ID.
• Added DELETE /fileTypeRules/{ruleId} to delete the File Type Control policy rule based on the specified ID.

ZIA Forwarding Control Policy - Proxy Gateways

PR #293 - Added the following new ZIA API Endpoints:

• Added GET /proxyGateways to retrieve the proxy gateway information.
• Added GET /proxyGateways/lite to retrieve the name and ID of the proxy.

ZIA Cloud Nanolog Streaming Service (NSS)

PR #293 - Added the following new ZIA API Endpoints:

• Added GET /nssFeeds to retrieve the cloud NSS feeds.
• Added GET /nssFeeds/{feedId} to retrieve information about cloud NSS feed based on the specified ID.
• Added POST /nssFeeds to add a new cloud NSS feed.
• Added PUT /nssFeeds/{feedId} to update cloud NSS feed configuration based on the specified ID.
• Added DELETE /nssFeeds/{feedId} to delete cloud NSS feed configuration based on the specified ID.
• Added GET /nssFeeds/feedOutputDefaults to retrieve the default cloud NSS feed output format for different log types.
• Added GET /nssFeeds/testConnectivity/{feedId} to test the connectivity of cloud NSS feed based on the specified ID
• Added POST /nssFeeds/validateFeedFormat to validates the cloud NSS feed f