Configuring Collection Variables

To configure collection variables:

1. In the workspace where you added your collection, go to Collections.

2. Click the OneAPI collection folder name.

3. Go to the Variables tab displayed for the collection. The variables present in the collection are displayed in a table, with values prepopulated for variables that are universal to all organizations (e.g., base URL for APIs).

4. For variables that contain values specific to the organization, such as client ID, client secret, Authentication Service's token endpoint, etc., you must configure the values manually. For each variable, enter its value into the Initial value column, then re-enter the same value in the Current value column.

   The following table shows the variables and a description of their values:

   Variable Name	Description
   clientID	API client ID obtained from Authentication Service.
   clientSecret	API client secret obtained from Authentication Service.
   customerId	Zscaler Private Access (ZPA) tenant ID of the customer obtained from Authentication Service or ZPA. To learn how to obtain the ZPA customer ID, see Getting Started. This configuration is applicable only to ZPA API clients.
   oneAPIBaseUrl	This variable is prepopulated with the base URL for OneAPI: https://api.zsapi.net.
   ZIABaseUrl	This variable is prepopulated with the base URL for Zscaler Internet Access (ZIA) API: {{oneAPIBaseUrl}}/zia/api/v1, which would become https://api.zsapi.net/zia/api/v1 when the {{oneAPIBaseUrl}} variable is replaced with its value.
   ZPABaseUrl	This variable is prepopulated with the base URL for ZPA API: {{oneAPIBaseUrl}}/zpa, which would become https://api.zsapi.net/zpa when the {{oneAPIBaseUrl}} variable is replaced with its value.
   ZCCBaseUrl	This variable is prepopulated with the base URL for Client Connector API: {{oneAPIBaseUrl}}/zcc/papi/public, which would become https://api.zsapi.net/zcc/papi/public when the {{oneAPIBaseUrl}} variable is replaced with its value.
   ZTWBaseUrl	This variable is prepopulated with the base URL for Cloud & Branch Connector API: {{oneAPIBaseUrl}}/ztw/api/v1, which would become https://api.zsapi.net/ztw/api/v1 when the {{oneAPIBaseUrl}} variable is replaced with its value.
   ZDXBaseUrl	This variable is prepopulated with the base URL for Zscaler Digital Experience (ZDX) API: {{oneAPIBaseUrl}}/zdx/v1, which would become https://api.zsapi.net/zdx/v1 when the {{oneAPIBaseUrl}} variable is replaced with its value.
   authServiceBaseUrl	Represents Authentication Service's token endpoint: https://<Vanity Domain>.zslogin.net, where <Vanity Domain> refers to the domain name used by your organization.
   ZBIBaseUrl	This variable is prepopulated with the base URL for Business Insights API: {{oneAPIBaseUrl}}/bi, which would become https://api.zsapi.net/bi when the {{oneAPIBaseUrl}} variable is replaced with its value.
   EASMBaseUrl	This variable is prepopulated with the base URL for EASM API: {{oneAPIBaseUrl}}/easm/easm-ui/v1, which would become https://api.zsapi.net/easm/easm-ui/v1 when the {{oneAPIBaseUrl}} variable is replaced with its value.
   AIInfrastructureBaseUrl	This variable is prepopulated with the base URL for AI Infrastructure endpoints of the AI Security API: {{oneAPIBaseUrl}}/aisecurity/aispm, which would become https://api.zsapi.net/aisecurity/aispm when the {{oneAPIBaseUrl}} variable is replaced with its value.
   AIRedTeamingBaseUrl	This variable is prepopulated with the base URL for AI Red Teaming endpoints of the AI Security API: {{oneAPIBaseUrl}}/aisecurity/airt, which would become https://api.zsapi.net/aisecurity/airt when the {{oneAPIBaseUrl}} variable is replaced with its value.
   UrbacBaseUrl	This variable is prepopulated with the base URL for Unified Role-Based Access Control (RBAC) API: {{oneAPIBaseUrl}}/urbac/urbac, which would become https://api.zsapi.net/urbac/urbac when the {{oneAPIBaseUrl}} variable is replaced with its value.

   NOTE

   Ensure that the variables are selected and configured properly.

5. Click the Save icon displayed in the top-right of the collection window.