Axonius Documentation
Start typing to search…

Zscaler Web Security

Zscaler Web Security is a secure Internet and web gateway service that stops malware, advanced threats, phishing, browser exploits, malicious URLs, botnets, and more.

This adapter is compatible with Zscaler Internet Access (ZIA).

Asset Types Fetched

This adapter fetches the following types of assets:

  • Devices, Users, SaaS Applications, Network/Firewall Rules

Before You Begin

Authentication Methods

You can authenticate this adapter using either of the following methods:

  • API Key
  • OAuth 2.0 authentication (ZIdentity)
❗️

Note

This adapter won't be able to fetch Devices when using OAuth 2.0 authentication.

See Connecting the Adapter in Axonius for the connection parameters required for each authentication.

Required Permissions

Under the 'Edit Administrator Role' section in Zscaler, enable the following permissions:

  • Access Control
  • Policy and resource management
    • Zscaler Client Connector Portal
  • Traffic Forwarding
    • Zscaler Client Connector Devices
  • Authentication Configuration
    • User Management
  • Administrator's Access
    • View Only
  • Dashboard Access
    • View Only
  • Policy Access
    • View Only
  • Reporting Access
    • View Only
📘

Note

The value that you have in the Zscaler Domain parameter must be open in the firewall.

Connecting the Adapter in Axonius

Required Parameters - General

  1. Zscaler Domain (default: admin.zscalerthree.net) - Specify the Zscaler cloud name that was provisioned for your organization. For example:

    • admin.zscalerbeta.net
    • admin.zscalerone.net
    • admin.zscalertwo.net
    • admin.zscaler.net
    • admin.zscloud.net
    • admin.zscalerdomain.net
    • mobileadmin.zscalerdomain.net
    • mobile.zscalerdomain.net

    For more details, see 'Retrieve your base URI and API key' section under Zscaler API - Getting Started.

📘

Note

Your organization may use a Zscaler domain for Single Sign On (SSO) that is different from the Base URL. This domain may need to be accounted for in firewall rule configurations to allow for a successful connection.

  1. Auth Method - Select either API Key (default) or ZIdentity.

Required Parameters - API Key Authentication

  1. User Name and Password - The user name and password used to connect to Zscaler Web Security.
  2. API Key - Your organization's API key. The API key is mandatory to fetch user data from Zscaler. For more details about adding a new API key, see Zscaler documentation - About API Key Management.
zscaler web security connection

Required Parameters - OAuth 2.0 (ZIdentity) Authentication

  1. Client ID and Client Secret - The client credentials sent in the request that were verified by ZIdentity, using the client registration details configured in the ZIdentity Admin Portal. See OAuth 2.0 Client Registration for more details on the creation and syntax of these parameters.
  2. Vanity Domain - The domain name used by your organization. For more information, see the 'Accessing OneAPI' section in the Zscaler Getting Started with OneAPI docs.

For general information on OAuth 2.0 (ZIdentity) Authentication, see Zscaler OneAPI Help.

zscaler_auth

Optional Parameters

  1. Company ID - Enter the Company ID. This parameter is required if the Fetch Zscaler Client Connector enrolled devicesadvanced setting is selected.
  2. Verify SSL - Select to verify the SSL certificate offered by the value supplied in Zscaler Domain. For more details, see SSL Trust & CA Settings.
  3. HTTPS Proxy - A proxy to use when connecting to the value supplied in Zscaler Domain.

To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

Advanced Settings

📘

Note

Advanced settings can either apply to all connections for this adapter, or to a specific connection. Refer to Advanced Configuration for Adapters.

Selecting Asset Types

In Advanced Settings, at the top of the Advanced Configuration, you can choose asset types that are relevant to specific advanced configurations.

  1. From the dropdown, select one or more asset types.
  2. The relevant advanced configurations are displayed.
  3. Next to certain configurations, you can find a small icon. Hover over the icon to see more information.
  4. The Advanced Configuration page is divided into sections, which can be collapsed to make it easier to navigate.

Data Enrichment

  1. Fetch users (required, default: true) - Select this option to fetch users data. Each user is added as a user asset in Axonius.
  2. Enrich devices service status - Select this option to enrich device information with Service Status data.
  3. Add last used users information for duplicated devices (if "Avoid hostnames duplications" is enabled) - Select this option to add the last used users information for duplicated devices. This is applicable only when “Avoid hostnames duplications” is used.
  4. Add Device Manufacturer Serial for Zscaler devices - Select this option to extract the device manufacturer serial number from the UDID and add it to the device.
  5. Discover Application Users (required, default: true) - By default this adapter fetches SaaS application users. Clear this option to not fetch SaaS application users.

Fetch and Parse

  1. Ignore duplicated MAC addresses - Select this option to ignore MAC addresses that are associated with more than one device fetched from Zscaler.
  2. Avoid hostnames duplications - Select this option to avoid returning duplicate hostname fetches.
  3. Fetch Zscaler Client Connector enrolled devices - Select this option to fetch enrolled devices from the Zscaler Client Connector.
📘

Note

When Fetch Zscaler Client Connector enrolled devices is selected, you must enter a value in the Company ID parameter.

  1. Fetch Firewalls - Select this option to fetch firewall policies data.
  2. Filter SaaS Applications data by timeframe - Filter the SaaS Apps report by the selected time period.
  3. Ignore SaaS Applications without users - Select this option to not fetch SaaS applications not assigned to any user.
  4. Ignore SaaS Applications Repository and parse all applications - Select this option to fetch all applications even if they are not in the Axonius SaaS Applications Repository.
  5. Filter out applications by name - Enter a name to filter out applications.
  6. Filter out applications by category - Enter a category to filter out applications.
  7. SaaS Applications Source - Select the source from with to fetch SaaS Applications: Shadow IT Report, Inferred by Insight Logs, or Both.
  8. Include Linux devices - Select this option to include devices that have the Linux operating system on the device fetch.
  9. Device Types to be Fetched - Filter the devices you want to fetch by registration status. Select between All states except Removed, Registered (default), Removal Pending (default), Unregistered, Removed, and Quarantined.

Advanced Configuration

  1. RateLimit (requests/hour) (optional, default: 700) - Enter the maximum rate of requests per hour by Axonius to the Zscaler server.
📘

Note

For details on general advanced settings under the Adapter Configuration tab, see Adapter Advanced Settings.

Related Enforcement Actions

Zscaler - Block URLs

Zscaler - Delete Users

Zscaler - Add or Remove URL to/from Category



Updated 5 days ago