icon-unified.svg
Experience Center

About App Connector Provisioning Keys

The domain (e.g., api.private.com) in the echo statement will depend on what cloud you are on.

The provisioning key is a text string that is generated when you add a new App Connector. When deploying an App Connector, you are prompted to enter this key. The provisioning key functions like an ID for the App Connector, enabling the cloud to verify the App Connector's authenticity and complete the deployment process. Furthermore, each key is associated to a specific App Connector group, so the key allows the cloud to identify the App Connector group to which an App Connector must be deployed.

App Connector provisioning keys provide the following benefits and enable you to:

  • Deploy App Connectors into an associated App Connector group.
  • Limit the number of times a key can be used for deployment.
  • View the current key utilization count.
  • Edit the maximum number of key uses.
  • Select the signing certificate used to enroll App Connector certificates.

Below is an example of an App Connector provisioning key:

1|api.private.zscaler.com|68F0AOEgpcG8McLmwdborq2m6v2A5oNEpSztJ/68F0AOEgpcG8McLmwdborq2m6v2 A5oNEpSztJ/68F0AOEgpcG8McLmwdborq2m6v2A5oNEpSztJ/68F0AOEgpcG8McLmwdborq2m6v2A5oNEpSztJ/68F0 AOEgpcG8McLmwdborq2m6v2A5oNEpSztJ/68F0AOEgpcG8McLmwdborq2m6v2A5oNEpSztJ/68F0AOEgpcG8McLmwdb orq2m6v2A5oNEpSztJ/68F0AOEgpcG8McLmwdborq2m6v2A5oNEpSztJ/68F0AOEgpcG8McLmwdborq2m6v2A5oNEpS ztJ/68F0AOEgpcG8McLmwdborq2m6v2A5oNEpSztJ==

Provisioning keys are designed to enable auto-scaling so that you can easily deploy additional App Connectors and respond optimally to increases in required capacity. When you generate a provisioning key, you can specify the number of times a key can be used to deploy App Connectors.

The number of times a key is used to deploy an App Connector is tracked and displayed on the App Connector Provisioning Keys page. When a key is used the maximum number of times, you cannot use it to deploy more App Connectors. However, you can always edit the maximum number of times a key can be used. You also have the option of associating multiple provisioning keys to a single App Connector group.

About the Connector Provisioning Keys Page

On the App Connector Provisioning Keys page (Infrastructure > Private Access > Component > App Connector Keys), you can do the following:

  1. Expand all of the rows in the table to see more information about each provisioning key.
  2. Filter the information that appears in the table. By default, no filters are applied.
  3. View a list of all the provisioning keys. For each key, you can see the following:
    • Name: The name of the key.
      • Signing Certificate: The enrollment certificate for the provisioning key.
    • Maximum # Of App Connector: The maximum number of App Connectors that can be deployed using the key.
    • Provisioning Key Utilization Count: The number of times the provisioning key has been used.
    • App Connector Group: The App Connector group associated with the key.
    • Provisioning Key: The key needed for deploying an App Connector.
  4. Copy the Provisioning Key to your clipboard.

If the Provisioning Key Utilization Count is reached, you cannot copy the key. A Warning icon appears next to the disabled Copy icon. You can edit the key to raise the limit.

When a provisioning key is incorrectly copied, the following error appears in your App Connector console when it tries to enroll:

notice:Checking Enrollment
        notice:No valid certificate. Attempting to enroll
        notice:Enroll: Connecting to api.private.zscaler.com via co2br.prod.zpath.net.
        error:Login request failed - http status(401) nonce(<3|api.private.zscaler.com|0/Z6lDT...>) fingerprint(<oXaN4RRiMc...>)
        notice:Certificate enrollment failed.
        
  1. Edit provisioning key details.
  2. Delete a provisioning key.

If a provisioning key is configured using Zscaler Deception, then the edit and delete options are unavailable.

  1. Download the provisioning key to your system in a file format.

     

Related Articles
About App Connector Provisioning KeysEditing App Connector Provisioning Keys