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.
Connector Version: 1.2.1
Authored By: Community
Certified: No
The following enhancements have been made to the Zscaler connector in version 1.2.1:
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root
user to install connectors from an SSH session:
yum install cyops-connector-zscaler
For the procedure to configure a connector, click here.
In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Zscaler connector card. On the connector popup, click the Configurations tab to enter the required configuration details:
Parameter | Description |
---|---|
Server URL | Specify the URL of the Zscaler server to which you will connect and perform the automated operations. |
API Key | Specify the API key that is configured for your account for using the Zscaler APIs |
Username | Specify the Username to access the Zscaler server to which you will connect and perform the automated operations. |
Password | Specify the 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. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
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 |
Get Cloud Sandbox Report Quota | Retrieves the cloud sandbox report quota from Zscaler. Note: The resource access quota for retrieving Sandbox Detail Reports is restricted to 1000 requests per day, with a rate limit of 2/sec and 1000/hour from Zscaler. |
get_sandbox_report_quota Investigation |
Get MD5 Cloud Sandbox Report | Retrieves a report (full or summary) of the file that was analyzed by the Sandbox in Zscaler based on the MD5 filehash value you have specified. | get_sandbox_report_md5_hash Investigation |
Add URL Category | Adds a new custom URL category in Zscaler based on the URLs and additional fields you have specified. | add_new_category Investigation |
Get URL Categories | Retrieves a list of all URL categories from Zscaler. | get_url_categories Investigation |
Get Lightweight URL Categories | Retrieves a lightweight key-value list of all (including custom) URL categories from Zscaler. | get_lightweight_url_categories Investigation |
Get URL Categories Quota | Retrieves information on the number of unique URLs that are currently provisioned for your organization. It also includes information on how many URLs you can add before reaching the categories quota number for your organization. | get_url_categories_quota Investigation |
Get URL Category Details | Retrieves the URL category information for the specified category ID from Zscaler. | get_url_category_info Investigation |
Update URL Category | Adds or removes URLs from the category list in Zscaler based on the category ID, URLs, and other input parameters you have specified. | update_url_category Miscellaneous |
Delete URL Category | Deletes a specific URL category from Zscaler based on the category ID you have specified. | delete_url_category Investigation |
URL Lookup | Looks up the categorization of the specified set of URLs in Zscaler. | url_lookup Investigation |
Get Exempted URLs | Retrieves a list of URLs that are exempted from the cookie authentication in Zscaler. | get_exempted_urls Investigation |
Update exempted URLs | Adds or removes a URL from the cookie authentication exempt list in Zscaler based on the URLs you have specified. | update_exempted_urls Miscellaneous |
None.
The output contains the following populated JSON schema:
{
"whitelistUrls": []
}
None.
The output contains the following populated JSON schema:
{
"blacklistUrls": []
}
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. |
The output contains the following populated JSON schema:
{
"whitelistUrls": []
}
Parameter | Description |
---|---|
URLs | CSV list of URLs that you want to add to the 'Blacklisted URL List' in Zscaler. Note: This action does not work for domains or URLs that end with a wildcard character. For example, (“.sampledomain.com.”) will not work. |
The output contains the following populated JSON schema:
{
"status": "",
"result": ""
}
Parameter | Description |
---|---|
URLs | CSV list of URLs that you want to remove from the 'Blacklisted URL List' in Zscaler. |
The output contains the following populated JSON schema:
{
"status": "",
"result": ""
}
None.
The output contains the following populated JSON schema:
{
"startTime": "",
"used": "",
"allowed": "",
"scale": "",
"unused": ""
}
Parameter | Description |
---|---|
MD5 Hash | Specify the MD5 filehash value of the file that was analyzed by the Sandbox in Zscaler for which you want to retrieve the report from Zscaler. |
Report Type | Select the type of report you want to retrieve from Zscaler. You can choose between full (default) or summary. |
The output contains the following populated JSON schema:
{
"DBotScore": {
"Vendor": "",
"Indicator": "",
"Score": "",
"Type": ""
},
"File": {
"Zscaler": {
"FileType": "",
"DetectedMalware": ""
},
"Malicious": {
"Vendor": "",
"Description": ""
},
"MD5": ""
}
}
Parameter | Description |
---|---|
URLs | Specify the set of URLs to be added in Zscaler. |
Additional Fields | Specify additional fields in the JSON format that you want to add to the new URL category in Zscaler. For example,{ |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
Parameter | Description |
---|---|
Custom Only | Select this option to retrieve information for only custom URL categories from Zscaler. |
Include Only URL Keyword Counts | Select this option, i.e., set it to true to include only URLs and keyword counts in the response. If this option is cleared, i.e., set to false (default), the response includes URLs and keywords. |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
None.
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
None.
The output contains the following populated JSON schema:
{
"uniqueUrlsProvisioned": "",
"remainingUrlsQuota": ""
}
Parameter | Description |
---|---|
Category ID | Specify the unique identifier for the URL category for which you want to retrieve information from Zscaler. |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
Parameter | Description |
---|---|
Category ID | Specify the unique identifier of the URL category in which you want to add or remove URLs in Zscaler. |
Action | Select the action that you want to perform on the specified list of URLs. You can choose between Add to List to add the specified URLs to the 'Whitelisted URL List' in Zscaler or Remove from List to remove the specified URLs from the 'Whitelisted URL List' in Zscaler. |
URLs | Specify the set of URLs to be updated in the specified URL category in Zscaler. |
Additional Fields | Specify additional fields in the JSON format that you want to update in the URL category in Zscaler. For example,{ |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
Parameter | Description |
---|---|
Category ID | Specify the unique identifier of the URL category that you want to delete from Zscaler. |
The output contains the following populated JSON schema:
{
"Zscaler": {
"Category": {
"CustomCategory": "",
"Description": "",
"ID": "",
"URL": []
}
}
}
Parameter | Description |
---|---|
URLs | Specify the set of URLs that you want to be looked up in Zscaler. |
The output contains the following populated JSON schema:
{
"url": "",
"urlClassifications": [],
"urlClassificationsWithSecurityAlert": []
}
None.
The output contains the following populated JSON schema:
{
"urls": []
}
Parameter | Description |
---|---|
Action | Select the action that you want to perform on the specified list of URLs. You can choose between Add to List to add the specified URLs to the 'Exempted URLs List' in Zscaler or Remove from List to remove the specified URLs from the 'Exempted URLs List' in Zscaler. |
URLs | Specify the set of URLs to be updated in the 'Exempted URLs List' in Zscaler. |
The output contains the following populated JSON schema:
{
"urls": []
}
The Sample - Zscaler - 1.2.1
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.
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.
Connector Version: 1.2.1
Authored By: Community
Certified: No
The following enhancements have been made to the Zscaler connector in version 1.2.1:
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root
user to install connectors from an SSH session:
yum install cyops-connector-zscaler
For the procedure to configure a connector, click here.
In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Zscaler connector card. On the connector popup, click the Configurations tab to enter the required configuration details:
Parameter | Description |
---|---|
Server URL | Specify the URL of the Zscaler server to which you will connect and perform the automated operations. |
API Key | Specify the API key that is configured for your account for using the Zscaler APIs |
Username | Specify the Username to access the Zscaler server to which you will connect and perform the automated operations. |
Password | Specify the 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. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
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 |
Get Cloud Sandbox Report Quota | Retrieves the cloud sandbox report quota from Zscaler. Note: The resource access quota for retrieving Sandbox Detail Reports is restricted to 1000 requests per day, with a rate limit of 2/sec and 1000/hour from Zscaler. |
get_sandbox_report_quota Investigation |
Get MD5 Cloud Sandbox Report | Retrieves a report (full or summary) of the file that was analyzed by the Sandbox in Zscaler based on the MD5 filehash value you have specified. | get_sandbox_report_md5_hash Investigation |
Add URL Category | Adds a new custom URL category in Zscaler based on the URLs and additional fields you have specified. | add_new_category Investigation |
Get URL Categories | Retrieves a list of all URL categories from Zscaler. | get_url_categories Investigation |
Get Lightweight URL Categories | Retrieves a lightweight key-value list of all (including custom) URL categories from Zscaler. | get_lightweight_url_categories Investigation |
Get URL Categories Quota | Retrieves information on the number of unique URLs that are currently provisioned for your organization. It also includes information on how many URLs you can add before reaching the categories quota number for your organization. | get_url_categories_quota Investigation |
Get URL Category Details | Retrieves the URL category information for the specified category ID from Zscaler. | get_url_category_info Investigation |
Update URL Category | Adds or removes URLs from the category list in Zscaler based on the category ID, URLs, and other input parameters you have specified. | update_url_category Miscellaneous |
Delete URL Category | Deletes a specific URL category from Zscaler based on the category ID you have specified. | delete_url_category Investigation |
URL Lookup | Looks up the categorization of the specified set of URLs in Zscaler. | url_lookup Investigation |
Get Exempted URLs | Retrieves a list of URLs that are exempted from the cookie authentication in Zscaler. | get_exempted_urls Investigation |
Update exempted URLs | Adds or removes a URL from the cookie authentication exempt list in Zscaler based on the URLs you have specified. | update_exempted_urls Miscellaneous |
None.
The output contains the following populated JSON schema:
{
"whitelistUrls": []
}
None.
The output contains the following populated JSON schema:
{
"blacklistUrls": []
}
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. |
The output contains the following populated JSON schema:
{
"whitelistUrls": []
}
Parameter | Description |
---|---|
URLs | CSV list of URLs that you want to add to the 'Blacklisted URL List' in Zscaler. Note: This action does not work for domains or URLs that end with a wildcard character. For example, (“.sampledomain.com.”) will not work. |
The output contains the following populated JSON schema:
{
"status": "",
"result": ""
}
Parameter | Description |
---|---|
URLs | CSV list of URLs that you want to remove from the 'Blacklisted URL List' in Zscaler. |
The output contains the following populated JSON schema:
{
"status": "",
"result": ""
}
None.
The output contains the following populated JSON schema:
{
"startTime": "",
"used": "",
"allowed": "",
"scale": "",
"unused": ""
}
Parameter | Description |
---|---|
MD5 Hash | Specify the MD5 filehash value of the file that was analyzed by the Sandbox in Zscaler for which you want to retrieve the report from Zscaler. |
Report Type | Select the type of report you want to retrieve from Zscaler. You can choose between full (default) or summary. |
The output contains the following populated JSON schema:
{
"DBotScore": {
"Vendor": "",
"Indicator": "",
"Score": "",
"Type": ""
},
"File": {
"Zscaler": {
"FileType": "",
"DetectedMalware": ""
},
"Malicious": {
"Vendor": "",
"Description": ""
},
"MD5": ""
}
}
Parameter | Description |
---|---|
URLs | Specify the set of URLs to be added in Zscaler. |
Additional Fields | Specify additional fields in the JSON format that you want to add to the new URL category in Zscaler. For example,{ |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
Parameter | Description |
---|---|
Custom Only | Select this option to retrieve information for only custom URL categories from Zscaler. |
Include Only URL Keyword Counts | Select this option, i.e., set it to true to include only URLs and keyword counts in the response. If this option is cleared, i.e., set to false (default), the response includes URLs and keywords. |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
None.
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
None.
The output contains the following populated JSON schema:
{
"uniqueUrlsProvisioned": "",
"remainingUrlsQuota": ""
}
Parameter | Description |
---|---|
Category ID | Specify the unique identifier for the URL category for which you want to retrieve information from Zscaler. |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
Parameter | Description |
---|---|
Category ID | Specify the unique identifier of the URL category in which you want to add or remove URLs in Zscaler. |
Action | Select the action that you want to perform on the specified list of URLs. You can choose between Add to List to add the specified URLs to the 'Whitelisted URL List' in Zscaler or Remove from List to remove the specified URLs from the 'Whitelisted URL List' in Zscaler. |
URLs | Specify the set of URLs to be updated in the specified URL category in Zscaler. |
Additional Fields | Specify additional fields in the JSON format that you want to update in the URL category in Zscaler. For example,{ |
The output contains the following populated JSON schema:
{
"id": "",
"configuredName": "",
"keywords": [],
"keywordsRetainingParentCategory": [],
"urls": [],
"dbCategorizedUrls": [],
"ipRanges": [],
"ipRangesRetainingParentCategory": [],
"customCategory": "",
"scopes": [
{
"scopeGroupMemberEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
],
"Type": "",
"ScopeEntities": [
{
"id": "",
"name": "",
"extensions": {
"additionalProp1": "",
"additionalProp2": "",
"additionalProp3": ""
}
}
]
}
],
"editable": "",
"description": "",
"type": "",
"urlKeywordCounts": {
"totalUrlCount": "",
"retainParentUrlCount": "",
"totalKeywordCount": "",
"retainParentKeywordCount": ""
},
"customUrlsCount": "",
"urlsRetainingParentCategoryCount": "",
"customIpRangesCount": "",
"ipRangesRetainingParentCategoryCount": ""
}
Parameter | Description |
---|---|
Category ID | Specify the unique identifier of the URL category that you want to delete from Zscaler. |
The output contains the following populated JSON schema:
{
"Zscaler": {
"Category": {
"CustomCategory": "",
"Description": "",
"ID": "",
"URL": []
}
}
}
Parameter | Description |
---|---|
URLs | Specify the set of URLs that you want to be looked up in Zscaler. |
The output contains the following populated JSON schema:
{
"url": "",
"urlClassifications": [],
"urlClassificationsWithSecurityAlert": []
}
None.
The output contains the following populated JSON schema:
{
"urls": []
}
Parameter | Description |
---|---|
Action | Select the action that you want to perform on the specified list of URLs. You can choose between Add to List to add the specified URLs to the 'Exempted URLs List' in Zscaler or Remove from List to remove the specified URLs from the 'Exempted URLs List' in Zscaler. |
URLs | Specify the set of URLs to be updated in the 'Exempted URLs List' in Zscaler. |
The output contains the following populated JSON schema:
{
"urls": []
}
The Sample - Zscaler - 1.2.1
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.