Fortinet Document Library

Version:


Table of Contents

1.1.0
Copy Link

About the connector

Zscaler is a global cloud-based information security company that provides Internet security, web security, next-generation firewalls, sandboxing, SSL inspection, antivirus, vulnerability management and granular control of user activity in cloud computing, mobile and Internet of things environments.

This document provides information about the Zscaler connector, which facilitates automated interactions with a Zscaler server using FortiSOAR™ playbooks. Add the Zscaler connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list of whitelisted and blacklisted URLs, and adding or removing a URL from the blacklist.

Version information

Connector Version: 1.1.0

Authored By: Community

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the Zscaler connector in version 1.1.0:

  • Fixed the "Authentication Mechanism" of the connector, by picking up the session ID from the 'Payload' instead of the 'Header'.

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-zscaler

Prerequisites to configuring the connector

  • You must have the URL of the Zscaler server to which you will connect and perform automated operations and credentials (username-password pair) to access that server.
  • You must also have the API Key to access the Zscaler endpoint.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Symantec DLP connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server URL URL of the Zscaler server to which you will connect and perform the automated operations.
API Key API key used to access the Zscaler endpoint to which you will connect and perform the automated operations.
Username Username to access the Zscaler server to which you will connect and perform the automated operations.
Password Password to access the Zscaler server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from version 4.10.0 onwards:

Function Description Annotation and Category
Get Whitelist URLs Retrieves the list of all the whitelisted URLs from Zscaler. whitelist_url
Investigation
Get Blacklist URLs Retrieves the list of all the blacklisted URLs from Zscaler. blacklist_url
Investigation
Update Whitelist URLs Adds or removes URLs from the "Whitelisted URL List" in Zscaler based on the URL and action you have specified. update_whitelist_urls
Miscellaneous
Block URLs Adds URLs to the "Blacklisted URL List" in Zscaler based on the URLs you have specified. block_url
Containment
Unblock URLs Removes URLs from the "Blacklisted URL List" in Zscaler based on the URLs you have specified. unblock_url
Remediation

operation: Get Whitelist URLs

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "whitelistUrls": []
}

operation: Get Blacklist URLs

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "blacklistUrls": []
}

operation: Update Whitelist URLs

Input parameters

Parameter Description
URLs CSV list of URLs that you want to add or remove from the 'Whitelisted URL List' in Zscaler.
Action Action that you want to perform on the specified list of URLs. Choose the Add in List option to add the specified URLs to the 'Whitelisted URL List' in Zscaler. Choose the Remove from List option to remove the specified URLs from the 'Whitelisted URL List' in Zscaler. 

Output

The output contains the following populated JSON schema:
{
     "whitelistUrls": []
}

operation: Block URLs

Input parameters

Parameter Description
URLs CSV list of URLs that you want to add to the 'Blacklisted URL List' in Zscaler.

Output

The output contains the following populated JSON schema:
{
     "status": "",
     "result": ""
}

operation: Unblock URLs

Input parameters

Parameter Description
URLs CSV list of URLs that you want to remove from the 'Blacklisted URL List' in Zscaler.

Output

The output contains the following populated JSON schema:
{
     "status": "",
     "result": ""
}

Included playbooks

The Sample - Zscaler - 1.1.0 playbook collection comes bundled with the Zscaler connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Zscaler connector.

  • Block URLs
  • Get Blacklist URLs
  • Get Whitelist URLs
  • Unblock URLs
  • Update Whitelist URLs

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.

About the connector

Zscaler is a global cloud-based information security company that provides Internet security, web security, next-generation firewalls, sandboxing, SSL inspection, antivirus, vulnerability management and granular control of user activity in cloud computing, mobile and Internet of things environments.

This document provides information about the Zscaler connector, which facilitates automated interactions with a Zscaler server using FortiSOAR™ playbooks. Add the Zscaler connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list of whitelisted and blacklisted URLs, and adding or removing a URL from the blacklist.

Version information

Connector Version: 1.1.0

Authored By: Community

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the Zscaler connector in version 1.1.0:

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-zscaler

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Symantec DLP connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

Parameter Description
Server URL URL of the Zscaler server to which you will connect and perform the automated operations.
API Key API key used to access the Zscaler endpoint to which you will connect and perform the automated operations.
Username Username to access the Zscaler server to which you will connect and perform the automated operations.
Password Password to access the Zscaler server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from version 4.10.0 onwards:

Function Description Annotation and Category
Get Whitelist URLs Retrieves the list of all the whitelisted URLs from Zscaler. whitelist_url
Investigation
Get Blacklist URLs Retrieves the list of all the blacklisted URLs from Zscaler. blacklist_url
Investigation
Update Whitelist URLs Adds or removes URLs from the "Whitelisted URL List" in Zscaler based on the URL and action you have specified. update_whitelist_urls
Miscellaneous
Block URLs Adds URLs to the "Blacklisted URL List" in Zscaler based on the URLs you have specified. block_url
Containment
Unblock URLs Removes URLs from the "Blacklisted URL List" in Zscaler based on the URLs you have specified. unblock_url
Remediation

operation: Get Whitelist URLs

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "whitelistUrls": []
}

operation: Get Blacklist URLs

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
     "blacklistUrls": []
}

operation: Update Whitelist URLs

Input parameters

Parameter Description
URLs CSV list of URLs that you want to add or remove from the 'Whitelisted URL List' in Zscaler.
Action Action that you want to perform on the specified list of URLs. Choose the Add in List option to add the specified URLs to the 'Whitelisted URL List' in Zscaler. Choose the Remove from List option to remove the specified URLs from the 'Whitelisted URL List' in Zscaler. 

Output

The output contains the following populated JSON schema:
{
     "whitelistUrls": []
}

operation: Block URLs

Input parameters

Parameter Description
URLs CSV list of URLs that you want to add to the 'Blacklisted URL List' in Zscaler.

Output

The output contains the following populated JSON schema:
{
     "status": "",
     "result": ""
}

operation: Unblock URLs

Input parameters

Parameter Description
URLs CSV list of URLs that you want to remove from the 'Blacklisted URL List' in Zscaler.

Output

The output contains the following populated JSON schema:
{
     "status": "",
     "result": ""
}

Included playbooks

The Sample - Zscaler - 1.1.0 playbook collection comes bundled with the Zscaler connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Zscaler connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during the connector upgrade and delete.