icon-zapp.svg
Client Connector

Customizing Zscaler Client Connector with Install Options for macOS

For Zscaler Client Connector version 3.9 and later for macOS, Zscaler Client Connector now uses a pkg installation process with plist (property list) configuration settings deployed from an MDM. Versions earlier than Zscaler Client Connector 3.9 for macOS used an installation script with variables. The deployment process for each is as follows:

For versions earlier than Zscaler Client Connector version 3.9 for macOS

You can deploy Zscaler Client Connector via the MDM (Mobile Device Management) used by your organization or by manually installing Zscaler Client Connector on a device.

To add install options to customize the app package for your organization using various command-line options:

  • To install the package using macOS command-line options:

    1. Open the Applications folder.
    2. Open the Utilities folder.
    3. Double-click the Terminal icon.
    4. Enter the following command:
    sudo sh <complete path>/Contents/MacOS/installbuilder.sh <install options>
    • Replace <complete path> with the absolute pathname to the package file. For example, /Users/Admin/Downloads/Zscaler-osx-1.5.2.6-installer.app
    • Replace <install options> with the one or more of the following install options:
      • If your organization is provisioned on more than one cloud, your users are asked to select the cloud to which their traffic is sent during the enrollment process.

        With this install option, you can specify the cloud to which the app must send user traffic so that your users do not have to make the selection during enrollment. This option is not needed if your organization is provisioned on one cloud. The app automatically sends traffic to the proper cloud and your users do not need to make a selection during enrollment.

        This install option is required if you enable the --strictEnforcement option.

        To add this option using the command-line, enter --cloudName <organization's cloud name in lowercase>. For example, if your cloud name is zscalertwo.net, you would enter zscalertwo. To learn more, see What is my cloud name for ZIA?

        Close
      • The --deviceToken install option only applies to Zscaler Internet Access (ZIA). It is not supported by Zscaler Private Access (ZPA).

        This install option allows you to use Zscaler Client Connector Portal as an IdP. The Zscaler service silently provisions and authenticates users even if you don't have an authentication mechanism in place. Before adding this option, you must generate a device token in Zscaler Client Connector Portal and complete the full configuration detailed in Using Zscaler Client Connector Portal as an IdP.

        To add this option using the command-line, enter --deviceToken <device token from the Zscaler Client Connector Portal>.

        A device token from the Zscaler Client Connector Portal

        Close
      • This install option forces the app window to stay hidden before users enroll. Users can always open the window by clicking the app icon in the system tray.

        To enable this option using the command-line, enter --hideAppUIOnLaunch 1. By default, the value is 0 (i.e., disabled).

        Close
      • By default, Zscaler Client Connector starts its services and user interface after installation. This install option prevents Zscaler Client Connector from automatically starting after installation. Users must open Zscaler Client Connector manually to start the app, or Zscaler Client Connector automatically runs after the next reboot.

        To disable this option using the command-line, enter --launchTray 0. By default, this value is 1 (i.e., enabled).

        Close
      • This install option allows you to install the app in silent mode.

        If you add this option for macOS, the --unattendedmodeui option with a value of none is required. To learn more, see --unattendedmodeui.

        To add this option using the command-line, enter --mode unattended

        Close
      • This install option allows you to specify which app profile policy you want to enforce for the app before the user enrolls. All relevant settings associated with the policy apply, including the bypass of the IdP login page. After the user enrolls, this policy is replaced with the app profile policy that matches the user based on group affiliation.

        Prerequisites:

        • This install option is only applicable, and required, if you enable the --strictEnforcement option and want users to enroll with the app before accessing the internet.
        • In Zscaler Client Connector Portal, you must configure the app profile policy that you want to enforce and ensure that the custom PAC file associated with that policy includes a bypass for your IdP login page. This allows the user to access the IdP page to log in as necessary before enrolling with the app.

        To add this option using the command-line, enter --policyToken <policy token from the Zscaler Client Connector Portal>.

        The policy token for a Zscaler Client Connector profile policy

        Close
      • This install option only works when the forwarding profile action for Zscaler Client Connector is Tunnel or Tunnel with Local Proxy. To learn more, see Configuring Forwarding Profiles for Zscaler Client Connector.

        This install option allows you to require users to enroll with the app before accessing the internet and blocks traffic in the following situations:

        • The user has not yet logged in after a new install.
        • A user logs in and logs out.
        • An administrator removes a device.

        This install option does not affect users that remain logged in and disable the ZIA service.

        If you enable this install option, the --cloudName and --policyToken options are required.

        To enable this option using the command-line, enter --strictEnforcement 1. By default, the value is 0 (i.e., disabled).

        Close
      • This install option allows you to control what's displayed to users if you are performing an unattended installation of the app.

        To add the install option using the command-line, enter --unattendedmodeui <value>, where <value> is one of the following:

        • none: Nothing is displayed to the user and no interaction is required. If you included the mode --unattended install option for macOS, you must include --unattendedmodeui with a value of none.
        • minimal: A small progress bar showing installation progress is displayed to the user and no interaction is required.
        • minimalWithDialogs: More information is displayed to the user with some dialogs that require user interaction.
        Close
      • This install option allows users to skip the app enrollment page. If SSO is enabled for your organization, users are taken directly to your organization's SSO login page. If you've integrated SSO with the app, users can also skip the SSO login page and are automatically enrolled with Zscaler service and logged in.

        To add the install option using the command-line, enter --userDomain <your organization's domain>. If your instance has multiple domains associated with it, enter the primary domain for your instance.

        Close
      • The –-externalRedirect install option redirects authentication to your organization’s SAML IdP through the Safari browser. When redirected to the browser for the first time, your users must select Remember Me on their IdP log-in screen. For any subsequent authentications, the browser remembers the user and automatically logs them in.

        To enable this option using the command-line, enter --externalRedirect true. The default is false.

        Close

    The following image is an example of a command-line that uses all the available install options above, where:

    • The absolute path to the package file is /Users/Admin/Downloads/Zscaler-osx-1.5.2.6-installer.app
    • The cloud on which the organization is provisioned is zscalertwo
    • The device token value is 123456789
    • The policy token value is 987654321
    • The organization's domain name is safemarch.com

    Installing the Zscaler Client Connector package with a command line

    Close
  • This configuration can only be used if your organization's domain is registered on a single cloud. If your organization's domain is registered on multiple clouds, use the command-line install options described earlier.

    This configuration achieves the same function as the --userDomain install option. The following guidelines apply:

    • Your organization is using Zscaler Client Connector version 1.5 or later.
    • If you've integrated your SSO with Zscaler Client Connector (using a mechanism like Integrated Windows Authentication (IWA), users can also skip the SSO login page and are automatically enrolled with Zscaler service and logged in.

    To allow users to log into the app without entering domains:

    1. Locate the macOS installer file.
    2. Prefix the file name with your organization's domain name. For example, if the file name is Zscaler-osx-1.5.0.326-installer and your organization's domain is safemarch.com, you would rename the file to safemarch.com-Zscaler-osx-1.5.0.326-installer.

    A configured Zscaler Client Connector macOS installer file that allows users to log in without entering domains

    Close

For versions Zscaler Client Connector 3.9 for macOS and later

If you are using Zscaler Client Connector version 3.9 or later for macOS, you must use a pkg installation process with property list (plist) configuration settings deployed from an MDM. The manual deployment process through install options is no longer applicable.

To install Zscaler Client Connector for your macOS devices, choose the following deployment procedure:

The steps for downloading and deploying the app vary by your MDM.

Related Articles
Understanding Zscaler Client Connector App DownloadsConfiguring Zscaler Client Connector for Microsoft 365 Cloud PCsCustomizing Zscaler Client Connector with Install Options for MSICustomizing Zscaler Client Connector with Install Options for EXECustomizing Zscaler Client Connector with Install Options for macOSCustomizing Zscaler Client Connector with Install Options for LinuxCustomizing Zscaler Client Connector with Install Options for AndroidCustomizing Zscaler Client Connector with Install Options for iOSDeploying Zscaler Client Connector with Active Directory for WindowsDeploying ZDX With Workspace ONE UEM for iOSDeploying ZDX with Jamf Pro for iOSDual Tunnel Feature Configuration with Jamf Pro for iOSDual Tunnel Feature Configuration with Microsoft Intune for iOSDeploying Zscaler Client Connector with MaaS360 for AndroidDeploying Zscaler Client Connector with MaaS360 for iOSDeploying Zscaler Client Connector with Microsoft Intune for AndroidDeploying Zscaler Client Connector with Microsoft Intune for macOSDeploying Zscaler Client Connector with Microsoft Intune for iOSDeploying Zscaler Client Connector with Google WorkspaceDeploying Zscaler Client Connector with MobileIron for iOSDeploying Zscaler Client Connector with MobileIron for AndroidDeploying Zscaler Client Connector with JAMF Pro for macOSDeploying Zscaler Client Connector with Jamf Pro for iOSDeploying Zscaler Client Connector with Workspace ONE UEM for AndroidDeploying Zscaler Client Connector with Workspace ONE UEM for iOSBlocking LAN AccessBest Practices for Zscaler Client Connector DeploymentBest Practices for Updating Latest Versions of Zscaler Client Connector ApplicationUninstalling Zscaler Client ConnectorReverting Zscaler Client Connector to the Previous VersionUpgrading Zscaler Client Connector