v3.1.4

3.1.4 (February 10, 2025)

Notes

• Golang: v1.22

Bug Fixes

PR #302 - Implemented fix on the legacy API clients for ZCC, ZIA and ZPA to prevent rate limit override after client instantiation.

Internal Changes

PR #302 - Updated SDK Header version to v3.1.4

v3.1.3

3.1.3 (February 5, 2025)

Notes

• Golang: v1.22

ZIA Policy Export

PR #301 - Added the following new ZIA API Endpoints:
- Added POST /exportPolicies Exports the rules configured for the specified policy types to JSON files.

Bug Fixes

PR #298 - Fixed ZCC ReadAllPages pagination function due to panic related to incorrect method reference.

v3.1.2

3.1.2 (January 28, 2025)

Notes

• Golang: v1.22

Bug Fixes

PR #297 - Fixed ZIA SSL Inspection Proxy Gateway attribute.

v3.1.1

3.1.1 (January 27, 2025)

Notes

• Golang: v1.22

Bug Fixes

PR #296 - Fixed ZIA Rate limit override issue to prevent inadvertent panic.

v3.1.0

3.1.0 (January 21, 2025)

Notes

• Golang: v1.22

ZIA SSL Inspection Rules

PR #295 - Added the following new ZIA API Endpoints:
- Added GET /sslInspectionRules Retrieves all SSL inspection rules.
- Added GET /sslInspectionRules/{ruleId} Retrieves the SSL inspection rule based on the specified ID
- Added POST /sslInspectionRules Creates a new SSL inspection rule
- Added PUT /sslInspectionRules/{ruleId} Updates the SSL inspection rule based on the specified ID
- Added DELETE /sslInspectionRules/{ruleId} Deletes an existing SSL inspection rule based on the specified ID

v3.0.0

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 format and returns the validation result

ZIA Advanced Threat Protection Policy

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

• Added GET /cyberThreatProtection/advancedThreatSettings to retrieve the advanced threat configuration settings.
• Added PUT /cyberThreatProtection/advancedThreatSettings to update the advanced threat configuration settings.
• Added GET /cyberThreatProtection/maliciousUrls to retrieve the malicious URLs added to the denylist in the Advanced Threat Protection (ATP) policy
• Added PUT /cyberThreatProtection/maliciousUrls to updates the malicious URLs added to the denylist in ATP policy
• Added GET /cyberThreatProtection/securityExceptions to retrieves information about the security exceptions configured for the ATP policy
• Added PUT /cyberThreatProtection/securityExceptions to update security exceptions for the ATP policy

ZIA Advanced Threat Protection Policy

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

• Added GET /cyberThreatProtection/atpMalwareInspection to retrieve the traffic inspection configurations of Malware Protection policy
• Added PUT /cyberThreatProtection/atpMalwareInspection to update the traffic inspection configurations of Malware Protection policy.
• Added GET /cyberThreatProtection/atpMalwareProtocols to retrieve the protocol inspection configurations of Malware Protection policy
• Added PUT /cyberThreatProtection/atpMalwareProtocols to update the protocol inspection configurations of Malware Protection policy.
• Added `GET /cyberThreatPr...

v2.74.2

2.74.2 (January 4, 2024)

Notes

• Golang: v1.22

Bug Fixes

PR #292 - Fixed ZPA Double Encoding of HTTP GET Request Params - Issue #291
PR #292 - Updated go mod packages
PR #292 - Fixed service edge controller listenips

v2.74.1

2.74.1 (January 4, 2024)

Notes

• Golang: v1.22

Bug Fixes

PR #292 - Fixed ZPA Double Encoding of HTTP GET Request Params - Issue #291
PR #292 - Updated go mod packages

v2.74.0

2.74.0 (November 14, 2024)

Notes

• Golang: v1.22

ZIA PAC Files

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

• Added GET /pacFiles to Retrieves the list of all PAC files which are in deployed state.
• Added GET /pacFiles/{pacId}/version to Retrieves all versions of a PAC file based on the specified ID.
• Added GET /pacFiles/{pacId}/version/{pacVersion} to Retrieves a specific version of a PAC file based on the specified ID.
• Added POST /pacFiles to Adds a new custom PAC file.
• Added DELETE /pacFiles/{pacId} to Deletes an existing PAC file including all of its versions based on the specified ID.
• Added PUT /pacFiles/{pacId}/version/{pacVersion}/action/{pacVersionAction} to Performs the specified action on the PAC file version and updates the file status.
• Added POST /pacFiles/validate to send the PAC file content for validation and returns the validation result.
• Added POST /pacFiles/{pacId}/version/{clonedPacVersion} to Adds a new PAC file version by branching an existing version based on the specified ID.

ZPA Additions - SCIM API

The SDK now supports interaction with the dedicated SCIM API Endpoint as described in the Zscaler Help documentation. The SCIM Service Provider Endpoints and references to scim1.private.zscaler.com.
To authenticate to the SCIM Service Provider Endpoint you can authenticate by providing the following information:

The ZPA Cloud is identified by several cloud name prefixes, which determines which API endpoint the requests should be sent to. The following cloud environments are supported:

• PRODUCTION
• ZPATWO
• BETA
• GOV
• GOVUS

Environment variables

You can provide credentials via the ZPA_SCIM_TOKEN, ZPA_IDP_ID, ZPA_SCIM_CLOUD environment variables, representing your ZPA scimToken, idpId, and scimCloud of your ZPA account, respectively.

~> NOTE 1 ZPA_SCIM_CLOUD environment variable is required, and is used to identify the correct API gateway where the API requests should be forwarded to.

~> NOTE 2 All SCIM APIs are rate limited.

Argument	Description	Environment variable
scimToken	(String) The ZPA SCIM Bearer token generated from the ZPA console.	ZPA_SCIM_TOKEN
idpId	(String) The ZPA IdP ID from the onboarded Identity Provider.	ZPA_IDP_ID
scimCloud	(String) The ZPA SCIM Cloud for your ZPA Tenant.	ZPA_SCIM_CLOUD

ZPA SCIM API Endpoints

PR #286 - Added the following ZPA SCIM API Endpoints:

• Added GET /Groups Fetch All Groups with pagination
• Added GET /Groups/{groupId} Fetch a Group By ID
• Added POST /Groups Create a new Group
• Added PUT /Groups/{groupId} Update a new Group
• Added PATCH /Groups/{groupId} Partially Update a Group

PR #286 - Added the following ZPA SCIM API Endpoints:

• Added GET /Users Fetch All Users with pagination
• Added GET /Users/{userID} Fetch a User By ID
• Added POST /Groups Create a new User
• Added PUT /Groups/{userID} Update a new User
• Added PATCH /Groups/{userID} Partially Update a User

v2.732.0

2.732.0 (October 31, 2024)

Notes

• Golang: v1.22

Internal Changes

PR #282 - Fixed update function in all specialized ZPA Application Segments
-applicationsegmentpra - The fix now automatically includes the attributes appId and praAppId in the payload during updates
- applicationsegmentinspection - The fix now automatically includes the attributes appId and inspectAppId in the payload during updates
- applicationsegmentbrowseraccess - The fix now automatically includes the attributes appId and baAppId in the payload during updates