Client Connector
Adding an API Key
An API key is required for authenticating with Zscaler back-end servers to make API calls.
Using an API key is available for Zscaler Client Connector version 3.6 and later for Windows.
If you need to obtain API keys or secrets to access Zscaler OneAPI endpoints, see About API Clients in ZIdentity.
To add a new API key:
- In the Zscaler Client Connector Portal, go to Administration > Public API.
Click Add API Key.
The Add API Key window appears.
In the Add API Key window:
- Name: Enter a name for the API key. The name must be alphanumeric, cannot contain spaces, and has a maximum of 50 characters.
- Status: Make sure Enabled is selected. If Disabled is selected, the key is unavailable to use. By default, this option is enabled.
- Role: Select Read or Write access for the key.
- Session Validity Interval (In Seconds): Enter the amount of time the key is available to use. Enter a range between 30 and 999,999,999 seconds.
- Click Save. The client secret for the key is displayed.
Copy the client secret to your clipboard. You need it for authentication.
The client secret is only available to copy when creating an API key. It is not available to access in the Zscaler Client Connector Portal after you close the window, so store it in a secure location.
- When finished, click Cancel to close the window.
