Skip to main content

Zscaler Internet Access via ZIdentity (Beta)

This Integration is part of the Zscaler Internet Access Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.10.0 and later.

beta

This is a beta Integration, which lets you implement and test pre-release software. Since the integration is beta, it might contain bugs. Updates to the integration during the beta phase might include non-backward compatible features. We appreciate your feedback on the quality and usability of the integration to help us identify issues, fix them, and continually improve.

This integration uses ZIdentity OAuth 2.0 client credentials to authenticate with Zscaler Internet Access (ZIA). It enables the management of denylists, allowlists, URL categories, IP destination groups, and users/groups, while also providing URL, IP, and domain classifications and sandbox reporting..

This integration is currently in Beta, allowing you to test pre-release software. Note that it may contain bugs, and future updates could include changes that are not backward compatible. We welcome your feedback to help us identify issues and improve the integration.

Configure Zscaler Internet Access via ZIdentity (Beta) in Cortex#

ParameterDescriptionRequired
Server URLThe Server URL assigned to your organization. For example, www.acme.zslogin.net.True
Client IDThe OAuth 2.0 client ID from ZIdentity.True
Client SecretThe OAuth 2.0 client secret from ZIdentity.True
Auto Activate ChangesIf enabled, the integration will activate the command changes after each execution. If disabled, use the 'zia-activate-changes' command to activate Zscaler command changes.False
Source ReliabilityReliability of the source providing the intelligence data.True
Suspicious URL categoriesSuspicious URL categories for security alerts. Default: SUSPICIOUS_DESTINATION, SPYWARE_OR_ADWARE.False
Trust any certificate (not secure)False
Use system proxy settingsFalse

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

zia-denylist-list#


Gets a list of URLs and IPs that are in the denylist.

Base Command#

zia-denylist-list

Input#

Argument NameDescriptionRequired
filterFilter results by URL or IP objects. Possible values are: url, ip.Optional
queryQuery to match against (Python regular expressions, for example, 8...8).Optional
limitThe number of items to return. Default is 50.Optional
all_resultsWhether to retrieve all results at once. Default is False.Optional

Context Output#

PathTypeDescription
ZIA.DenyListStringThe list of URLs and IPs on the denylist.

Command Example#

!zia-denylist-list filter=url limit=10

Human Readable Output#

Denylist#

URL
malware.com
phishing.net

zia-denylist-update#


Updates the list of URLs and IPs that are in the denylist.

Base Command#

zia-denylist-update

Input#

Argument NameDescriptionRequired
urlA comma-separated list of URLs to update the denylist. For example, snapchat.com,facebook.com.Optional
ipA comma-separated list of IPs to update the denylist. For example, 1.2.3.4,8.8.8.8.Optional
actionThe action applied to the denylist. Possible values are: ADD_TO_LIST, REMOVE_FROM_LIST, OVERWRITE.Required

Context Output#

There is no context output for this command.

Command Example#

!zia-denylist-update url=malware.com,phishing.net action=ADD_TO_LIST

Human Readable Output#

Denylist updated successfully.

zia-allowlist-list#


Gets a list of URLs and IPs that are in the allowlist.

Base Command#

zia-allowlist-list

Input#

Argument NameDescriptionRequired
filterFilter results by URL or IP objects. Possible values are: url, ip.Optional
queryQuery to match against (Python regular expressions, for example, 8...8).Optional
limitThe number of items to return. Default is 50.Optional
all_resultsWhether to retrieve all results at once. Default is False.Optional

Context Output#

PathTypeDescription
ZIA.AllowListStringThe list of URLs in the allowlist.

Command Example#

!zia-allowlist-list filter=url limit=10

Human Readable Output#

Allowlist#

URL
trusted.com
safe.net

zia-allowlist-update#


Updates the list of URLs that are in the allowlist.

Base Command#

zia-allowlist-update

Input#

Argument NameDescriptionRequired
urlA comma-separated list of URLs to update in the allowlist. For example, snapchat.com,facebook.com.Optional
ipA comma-separated list of IPs to update in the allowlist. For example, 1.2.3.4,8.8.8.8.Optional
actionThe action applied to the allowlist. Possible values are: ADD_TO_LIST, REMOVE_FROM_LIST, OVERWRITE.Required

Context Output#

There is no context output for this command.

Command Example#

!zia-allowlist-update url=trusted.com action=ADD_TO_LIST

Human Readable Output#

Allowlist updated successfully.

zia-category-list#


Gets information about all or custom URL categories. By default, the response includes keywords. The lite option cannot be used in combination with other parameters.

Base Command#

zia-category-list

Input#

Argument NameDescriptionRequired
category_idThe URL category for the specified ID. For more information about category ID values, see the Zscaler documentation.Optional
custom_onlyIf set to true, gets information on custom URL categories only. Default is false.Optional
include_only_url_keyword_countsIf set to true, the response only includes URL and keyword counts. Default is false.Optional
liteWhether to get a lightweight key-value list of all or custom URL categories. Cannot be used with other parameters. Default is false.Optional
limitThe number of items to return. Default is 50.Optional
all_resultsWhether to retrieve all results at once. Default is False.Optional
display_urlWhether to display the URLs of each category in the War Room. URLs will always be returned to the Context Data. Default is false.Optional

Context Output#

PathTypeDescription
ZIA.Category.idStringThe ID of the category.
ZIA.Category.configuredNameStringThe configured name of the category.
ZIA.Category.superCategoryStringThe super category of the category.
ZIA.Category.keywordsStringThe keywords associated with the category.
ZIA.Category.urlsStringThe URLs in the category.
ZIA.Category.customCategoryBooleanWhether the category is a custom category.

Command Example#

!zia-category-list custom_only=true

Context Example#

{
"ZIA": {
"Category": [
{
"id": "CUSTOM_01",
"configuredName": "My Custom Category",
"superCategory": "USER_DEFINED",
"keywords": ["example"],
"urls": ["example.com"],
"customCategory": true
}
]
}
}

Human Readable Output#

URL Categories#

IDConfigured NameSuper CategoryCustom Category
CUSTOM_01My Custom CategoryUSER_DEFINEDtrue

zia-category-update#


Updates the URL category for the specified ID.

Base Command#

zia-category-update

Input#

Argument NameDescriptionRequired
category_idThe URL category for the specified ID. For more information about category ID values, see the Zscaler documentation.Required
urlA comma-separated list of URLs to update in the specified category. For example, pandora.com,spotify.com. Important: If any URL contains a comma (,), you must pass the url argument as a JSON list wrapped in backticks (`). Example: url=`["https://example.com/foo,bar"]`.Optional
ipA comma-separated list of IP ranges to update in the specified category. For example, 1.2.3.4,8.8.8.8.Optional
actionThe action applied to the URL category. Possible values are: ADD_TO_LIST, REMOVE_FROM_LIST, OVERWRITE.Required
keywordsCustom keywords associated with a URL category. Up to 2048 custom keywords can be added per organization across all categories.Optional
descriptionDescription of the URL category. Contains tag name and needs to be localized on client side in case of predefined category.Optional
db_categorized_urlsURLs added to a custom URL category that are also retained under the original parent URL category.Optional
keywords_retaining_parent_categoryRetained custom keywords from the parent URL category. Up to 2048 retained parent keywords can be added per organization across all categories.Optional
ip_ranges_retaining_parent_categoryThe retaining parent custom IP address ranges associated with a URL category. Up to 2000 custom IP ranges and retaining parent custom IP address ranges can be added, per organization, across all categories.Optional

Context Output#

There is no context output for this command.

Command Example#

!zia-category-update category_id=CUSTOM_01 url=pandora.com,spotify.com action=ADD_TO_LIST

Human Readable Output#

Category CUSTOM_01 updated successfully.

zia-url-quota-get#


Gets information on the number of unique URLs that are currently provisioned for your organization as well as how many URLs you can add before reaching that number.

Base Command#

zia-url-quota-get

Input#

There are no input arguments for this command.

Context Output#

PathTypeDescription
ZIA.UrlQuota.uniqueUrlsProvisionedNumberThe number of unique URLs that are currently provisioned for your organization.
ZIA.UrlQuota.remainingUrlsQuotaNumberThe number of URLs you can add before reaching the quota.

Command Example#

!zia-url-quota-get

Context Example#

{
"ZIA": {
"UrlQuota": {
"uniqueUrlsProvisioned": 25000,
"remainingUrlsQuota": 24850
}
}
}

Human Readable Output#

URL Quota#

Unique URLs ProvisionedRemaining URLs Quota
2500024850

zia-ip-destination-group-list#


Gets a list of all IP destination groups or for the specified ID.

Base Command#

zia-ip-destination-group-list

Input#

Argument NameDescriptionRequired
group_idThe unique identifier for the IP destination group.Optional
include_ipv6Whether to retrieve IPv6 destination groups. Default is False.Optional
exclude_typeFilter based on the IP destination group's type. Possible values are: DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER.Optional
category_typeFilter based on the IP destination group's type. Possible values are: DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER.Optional
liteGets a lightweight dictionary (name and ID) of all IP destination groups. Default is False.Optional
limitThe number of items to return. Default is 50.Optional
all_resultsWhether to retrieve all results at once. Default is False.Optional

Context Output#

PathTypeDescription
ZIA.IPDestinationGroup.idNumberUnique identifier for the destination IP group.
ZIA.IPDestinationGroup.nameStringDestination IP group name.
ZIA.IPDestinationGroup.typeStringDestination IP group type.
ZIA.IPDestinationGroup.addressesStringDestination IP addresses, FQDNs, or wildcard FQDNs added to the group.
ZIA.IPDestinationGroup.descriptionStringAdditional information about the destination IP group.
ZIA.IPDestinationGroup.countriesStringDestination IP address countries.
ZIA.IPDestinationGroup.ipCategoriesStringDestination IP address URL categories.

Command Example#

!zia-ip-destination-group-list limit=5

Context Example#

{
"ZIA": {
"IPDestinationGroup": [
{
"id": 1234,
"name": "My IP Group",
"type": "DSTN_IP",
"addresses": ["8.8.8.8", "1.1.1.1"],
"description": "DNS servers",
"countries": [],
"ipCategories": []
}
]
}
}

Human Readable Output#

IP Destination Groups#

IDNameTypeAddressesDescription
1234My IP GroupDSTN_IP8.8.8.8, 1.1.1.1DNS servers

zia-ip-destination-group-update#


Updates an existing IP destination group.

Base Command#

zia-ip-destination-group-update

Input#

Argument NameDescriptionRequired
group_idThe unique identifier for the IP destination group.Required
group_nameDestination IP group name.Optional
group_typeDestination IP group type. Possible values are: DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER.Optional
addressDestination IP addresses.Optional
actionThe action applied to the addresses list. Possible values are: ADD_TO_LIST, REMOVE_FROM_LIST, OVERWRITE.Required
descriptionAdditional information about the destination IP group.Optional
ip_categoryDestination IP address URL categories. Possible values can be found here.Optional
countryDestination IP address countries. Possible values can be found here.Optional

Context Output#

PathTypeDescription
ZIA.IPDestinationGroup.idNumberUnique identifier for the destination IP group.
ZIA.IPDestinationGroup.nameStringDestination IP group name.
ZIA.IPDestinationGroup.typeStringDestination IP group type.
ZIA.IPDestinationGroup.addressesStringDestination IP addresses, FQDNs, or wildcard FQDNs added to the group.
ZIA.IPDestinationGroup.descriptionStringAdditional information about the destination IP group.
ZIA.IPDestinationGroup.countriesStringDestination IP address countries.
ZIA.IPDestinationGroup.ipCategoriesStringDestination IP address URL categories.

Command Example#

!zia-ip-destination-group-update group_id=1234 address=9.9.9.9 action=ADD_TO_LIST

Human Readable Output#

IP destination group 1234 updated successfully.

zia-ip-destination-group-add#


Adds a new IP destination group.

Base Command#

zia-ip-destination-group-add

Input#

Argument NameDescriptionRequired
group_nameDestination IP group name.Optional
group_typeDestination IP group type. Possible values are: DSTN_IP, DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER.Optional
addressDestination IP addresses.Optional
descriptionAdditional information about the destination IP group.Optional
ip_categoryDestination IP address URL categories. Possible values can be found here.Optional
countryDestination IP address countries. Possible values can be found here.Optional
is_non_editableIf set to true, the destination IP address group is non-editable. Default is false.Optional

Context Output#

PathTypeDescription
ZIA.IPDestinationGroup.idNumberUnique identifier for the destination IP group.
ZIA.IPDestinationGroup.nameStringDestination IP group name.
ZIA.IPDestinationGroup.typeStringDestination IP group type.
ZIA.IPDestinationGroup.addressesStringDestination IP addresses, FQDNs, or wildcard FQDNs added to the group.
ZIA.IPDestinationGroup.descriptionStringAdditional information about the destination IP group.
ZIA.IPDestinationGroup.countriesStringDestination IP address countries.
ZIA.IPDestinationGroup.ipCategoriesStringDestination IP address URL categories.

Command Example#

!zia-ip-destination-group-add group_name="New Group" group_type=DSTN_IP address=10.0.0.1

Context Example#

{
"ZIA": {
"IPDestinationGroup": {
"id": 5678,
"name": "New Group",
"type": "DSTN_IP",
"addresses": ["10.0.0.1"],
"description": "",
"countries": [],
"ipCategories": []
}
}
}

Human Readable Output#

IP destination group created successfully with ID 5678.

zia-ip-destination-group-delete#


Deletes the IP destination group for the specified ID.

Base Command#

zia-ip-destination-group-delete

Input#

Argument NameDescriptionRequired
group_idThe unique identifier for the IP destination group.Required

Context Output#

There is no context output for this command.

Command Example#

!zia-ip-destination-group-delete group_id=5678

Human Readable Output#

IP destination group 5678 deleted successfully.

zia-user-list#


Gets a list of all users or the user information for the specified ID.

Base Command#

zia-user-list

Input#

Argument NameDescriptionRequired
user_idFilters by the unique identifier for the user.Optional
deptFilters by department name.Optional
groupFilters by group name.Optional
pageSpecifies the page offset. Default is 1.Optional
page_sizeSpecifies the page size. The maximum size is 10,000. Default is 100.Optional
all_resultsWhether to retrieve all results at once. Default is False.Optional

Context Output#

PathTypeDescription
ZIA.User.idNumberThe unique identifier for the user.
ZIA.User.nameStringUser name.
ZIA.User.emailStringUser email address.
ZIA.User.commentsStringAdditional information about the user.

Command Example#

!zia-user-list dept="Engineering" page_size=50

Context Example#

{
"ZIA": {
"User": [
{
"id": 100,
"name": "John Doe",
"email": "john.doe@example.com",
"comments": "Engineering team member"
}
]
}
}

Human Readable Output#

Users#

IDNameEmailComments
100John Doejohn.doe@example.comEngineering team member

zia-user-update#


Updates the user information for the specified ID.

Base Command#

zia-user-update

Input#

Argument NameDescriptionRequired
user_idThe unique identifier for the user.Required
userFull user object as JSON. If provided, individual field arguments are applied on top of this.Optional
user_nameUser name. This appears when choosing users for policies.Optional
emailUser email consists of a user name and domain name.Optional
commentsAdditional information about this user.Optional
temp_auth_emailTemporary Authentication Email.Optional
passwordUser's password. Applicable only when authentication type is Hosted DB.Optional

Context Output#

PathTypeDescription
ZIA.User.idNumberThe unique identifier for the user.
ZIA.User.nameStringUser name.
ZIA.User.emailStringUser email address.
ZIA.User.commentsStringAdditional information about the user.

Command Example#

!zia-user-update user_id=100 comments="Updated comment"

Human Readable Output#

User 100 updated successfully.

zia-groups-list#


Gets a list of groups.

Base Command#

zia-groups-list

Input#

Argument NameDescriptionRequired
searchThe search string used to match against a group's name or comments attributes.Optional
defined_byThe string value defined by the group name or other applicable attributes.Optional
sort_bySorts the groups based on available values. Possible values are: id, name, expiry, status, externalId, rank, modTime. Default is id.Optional
sort_orderSorts the order of groups based on available values. Possible values are: asc, desc, ruleExecution. Default is asc.Optional
pageSpecifies the page offset. Default is 1.Optional
page_sizeSpecifies the page size. The maximum size is 10,000. Default is 100.Optional
all_resultsWhether to retrieve all results at once. Default is False.Optional

Context Output#

PathTypeDescription
ZIA.Groups.idNumberThe unique identifier for the group.
ZIA.Groups.nameStringGroup name.
ZIA.Groups.idpIdNumberUnique identifier for the identity provider (IdP).
ZIA.Groups.commentsStringAdditional information about the group.
ZIA.Groups.isSystemDefinedBooleanWhether the group is system-defined.

Command Example#

!zia-groups-list search="Engineering" sort_by=name sort_order=asc

Context Example#

{
"ZIA": {
"Groups": [
{
"id": 200,
"name": "Engineering",
"idpId": 1,
"comments": "Engineering department group",
"isSystemDefined": false
}
]
}
}

Human Readable Output#

Groups#

IDNameIdP IDCommentsSystem Defined
200Engineering1Engineering department groupfalse

zia-departments-list#


Gets a list of all departments or the department information for the specified ID.

Base Command#

zia-departments-list

Input#

Argument NameDescriptionRequired
department_idUnique identifier for the department.Optional
searchThe search string used to match against a department's name or comments attributes.Optional
limit_searchWhether to limit the search to match only against the department name. Default is false.Optional
sort_bySorts the departments based on available values. Possible values are: id, name, expiry, status, externalId, rank. Default is id.Optional
sort_orderSorts the order of departments based on available values. Possible values are: asc, desc, ruleExecution. Default is asc.Optional
pageSpecifies the page offset. Default is 1.Optional
page_sizeSpecifies the page size. The maximum size is 10,000. Default is 100.Optional
all_resultsWhether to retrieve all results at once. Default is False.Optional

Context Output#

PathTypeDescription
ZIA.Department.idNumberThe unique identifier for the department.
ZIA.Department.nameStringDepartment name.
ZIA.Department.idpIdNumberUnique identifier for the identity provider (IdP).
ZIA.Department.commentsStringAdditional information about the department.
ZIA.Department.deletedBooleanWhether the department is deleted.

Command Example#

!zia-departments-list search="Engineering"

Context Example#

{
"ZIA": {
"Department": [
{
"id": 300,
"name": "Engineering",
"idpId": 1,
"comments": "Engineering department",
"deleted": false
}
]
}
}

Human Readable Output#

Departments#

IDNameIdP IDCommentsDeleted
300Engineering1Engineering departmentfalse

zia-sandbox-report-get#


Gets a full or summary detail report for an MD5 hash of a file that was analyzed by Sandbox.

Base Command#

zia-sandbox-report-get

Input#

Argument NameDescriptionRequired
md5MD5 hash of the file that was analyzed by Sandbox.Required
report_typeType of report, full or summary. Possible values are: full, summary. Default is summary.Optional

Context Output#

PathTypeDescription
ZIA.SandboxReportUnknownThe full sandbox report response.
DBotScore.IndicatorStringThe indicator that was tested.
DBotScore.TypeStringThe indicator type.
DBotScore.VendorStringThe vendor used to calculate the score.
DBotScore.ScoreNumberThe actual score.
File.MD5StringThe MD5 hash of the file.
File.Malicious.VendorStringFor malicious files, the vendor that tagged the file as malicious.
File.Malicious.DescriptionStringFor malicious files, the reason the vendor tagged the file as malicious.
File.FileTypeStringThe file type.

Command Example#

!zia-sandbox-report-get md5=9de5069c5afe602b2ea0a04b66beb2c0 report_type=summary

Context Example#

{
"DBotScore": {
"Indicator": "9de5069c5afe602b2ea0a04b66beb2c0",
"Score": 3,
"Type": "file",
"Vendor": "Zscaler"
},
"File": {
"MD5": "9de5069c5afe602b2ea0a04b66beb2c0",
"FileType": "PE32",
"Malicious": {
"Vendor": "Zscaler",
"Description": "Malware detected"
}
},
"ZIA": {
"SandboxReport": {
"Summary": {
"Status": "MALICIOUS",
"Category": "Malware"
}
}
}
}

Human Readable Output#

Sandbox Report for 9de5069c5afe602b2ea0a04b66beb2c0#

StatusCategoryFile TypeScore
MALICIOUSMalwarePE323

zia-activate-changes#


Activates the saved configuration changes.

Base Command#

zia-activate-changes

Input#

There are no input arguments for this command.

Context Output#

PathTypeDescription
ZIA.ActivationStatus.statusStringThe activation status.

Command Example#

!zia-activate-changes

Context Example#

{
"ZIA": {
"ActivationStatus": {
"status": "ACTIVE"
}
}
}

Human Readable Output#

Activation Status#

Status
ACTIVE

url#


Retrieve Zscaler's default classification for a given set of URLs.

Base Command#

url

Input#

Argument NameDescriptionRequired
urlA comma-separated list of URLs for which to look up the classification. For example, abc.com,xyz.com. Up to 100 URLs can be looked up per request, and a URL cannot exceed 1,024 characters.Required

Context Output#

PathTypeDescription
ZIA.URL.DataStringThe URL that was searched.
ZIA.URL.AddressStringThe URL that was searched.
ZIA.URL.urlClassificationsStringThe classification of the URL.
ZIA.URL.urlClassificationsWithSecurityAlertStringThe classifications of the URLs that have security alerts.
URL.DataStringThe URL that was searched.
URL.AddressStringThe URL that was searched.
URL.Malicious.VendorStringFor malicious URLs, the vendor that tagged the URL as malicious.
URL.Malicious.DescriptionStringFor malicious URLs, the reason the vendor tagged the URL as malicious.
DBotScore.IndicatorStringThe indicator that was tested.
DBotScore.TypeStringThe indicator type.
DBotScore.VendorStringThe vendor used to calculate the score.
DBotScore.ScoreNumberThe actual score.
DBotScore.ReliabilityStringReliability of the source providing the intelligence data.

Command Example#

!url url=facebook.com

Context Example#

{
"DBotScore": [
{
"Indicator": "facebook.com",
"Score": 1,
"Type": "url",
"Vendor": "Zscaler",
"Reliability": "C - Fairly reliable"
}
],
"URL": {
"Address": "facebook.com",
"Data": "facebook.com"
},
"ZIA": {
"URL": {
"Address": "facebook.com",
"Data": "facebook.com",
"urlClassifications": "SOCIAL_NETWORKING",
"urlClassificationsWithSecurityAlert": []
}
}
}

Human Readable Output#

Zscaler URL Lookup#

URLClassificationsSecurity Alert Classifications
facebook.comSOCIAL_NETWORKING

ip#


Retrieve the classification for each of the specified IP addresses.

Base Command#

ip

Input#

Argument NameDescriptionRequired
ipA comma-separated list of IP addresses for which to look up the classification. For example, 8.8.8.8,1.2.3.4. The maximum number of IPs per call is 100.Required

Context Output#

PathTypeDescription
ZIA.IP.AddressStringThe IP address that was searched.
ZIA.IP.ClassificationsStringThe classification of the IP address.
ZIA.IP.ClassificationsWithSecurityAlertStringClassifications that have a security alert for the IP address.
IP.AddressStringThe IP address that was searched.
IP.Malicious.VendorStringFor malicious IP addresses, the vendor that tagged the IP address as malicious.
IP.Malicious.DescriptionStringFor malicious IP addresses, the reason the vendor tagged the IP address as malicious.
DBotScore.IndicatorStringThe indicator that was tested.
DBotScore.TypeStringThe indicator type.
DBotScore.VendorStringThe vendor used to calculate the score.
DBotScore.ScoreNumberThe actual score.
DBotScore.ReliabilityStringReliability of the source providing the intelligence data.

Command Example#

!ip ip=8.8.8.8

Context Example#

{
"DBotScore": [
{
"Indicator": "8.8.8.8",
"Score": 1,
"Type": "ip",
"Vendor": "Zscaler",
"Reliability": "C - Fairly reliable"
}
],
"IP": {
"Address": "8.8.8.8"
},
"ZIA": {
"IP": {
"Address": "8.8.8.8",
"Classifications": "WEB_SEARCH",
"ClassificationsWithSecurityAlert": []
}
}
}

Human Readable Output#

Zscaler IP Lookup#

IPClassificationsSecurity Alert Classifications
8.8.8.8WEB_SEARCH

domain#


Retrieve Zscaler's default classification for a given set of domains.

Base Command#

domain

Input#

Argument NameDescriptionRequired
domainA comma-separated list of domains for which to look up the classification. For example, abc.com,xyz.com. The maximum number of domains per call is 100.Required

Context Output#

PathTypeDescription
ZIA.Domain.DataStringThe domain that was searched.
ZIA.Domain.AddressStringThe domain that was searched.
ZIA.Domain.ClassificationsStringThe classification of the domain.
ZIA.Domain.ClassificationsWithSecurityAlertStringClassifications that have a security alert for the domain.
Domain.NameStringThe domain that was searched.
Domain.Malicious.VendorStringFor malicious domains, the vendor that tagged the domain as malicious.
Domain.Malicious.DescriptionStringFor malicious domains, the reason the vendor tagged the domain as malicious.
DBotScore.IndicatorStringThe indicator that was tested.
DBotScore.TypeStringThe indicator type.
DBotScore.VendorStringThe vendor used to calculate the score.
DBotScore.ScoreNumberThe actual score.
DBotScore.ReliabilityStringReliability of the source providing the intelligence data.

Command Example#

!domain domain=google.com

Context Example#

{
"DBotScore": [
{
"Indicator": "google.com",
"Score": 1,
"Type": "domain",
"Vendor": "Zscaler",
"Reliability": "C - Fairly reliable"
}
],
"Domain": {
"Name": "google.com"
},
"ZIA": {
"Domain": {
"Data": "google.com",
"Address": "google.com",
"Classifications": "WEB_SEARCH",
"ClassificationsWithSecurityAlert": []
}
}
}

Human Readable Output#

Zscaler Domain Lookup#

DomainClassificationsSecurity Alert Classifications
google.comWEB_SEARCH