WitnessAI Documentation
List
Start Here
Start Here
Analytics
Analytics
Conversations
Conversations
Users
Users
Alerts
Alerts
Policy
Policy
Administration
Administration
Apps & Resources
Apps & Resources
Release Notes
Release Notes
Administrator Guide
Administrator Guide
Zscaler OneAPI Configuration
Follow this guide if your Zscaler tenant has been migrated to OneAPI. WitnessAI authenticates to Zscaler OneAPI gateway using an API Client (Client ID + Client Secret) that is scoped to a ZIA API Role.
1. Create an API Role
An API role defines permission to WitnessAI to manage custom URL category via OneAPI
Create an API Role in the ZIA Admin Portal under Administration → Role Management → Add API Role
- Name → WitnessAI-API-Role
- Policy & Components → URL Categories
- URL Categories → Custom
- Zscaler Defined URL Category Management → None
- Custom URL Management → Full
- Override Existing Categories → None
- Set all other scopes as “None” or “View Only”
- Save, then Activate the change so the role is committed
2. Create the API Client
Go to Zidentity Admin Portal → Integration → API Clients → Add API Client
- Name → WitnessAI-API-Client
- Status → Active
- Access Token Lifetime → at least 60 minutes
- Client Authentication → Secret → click Add, then copy the generated Client Secret (it is shown only once and cannot be retrieved later)
- Resources → select WitnessAI-API-Role (the ZIA role created in Step 1)
Zidentity auto-creates API resources from the ZIA roles. Confirm the role synced:
- Under the ZIA dropdown, confirm WitnessAI-API-Role is listed
- If it is not listed, click Sync Now to run an on-demand sync, then re-check
- Save → Zidentity auto-generates the Client ID, shown on the API Clients page. Copy it.
3. Identify the Vanity Domain
The vanity domain is your organization’s identifier in the Zidentity login URL.
- If you sign in at companyname.zslogin.net (or companyname-admin.zslogin.net), your vanity domain is companyname
- It can also be found under ZIA portal → Administration → Company Profile → Organization → Domains
Once the above configuration is completed, please hand over the below details to the WitnessAI account team:
- Client ID
- Client Secret
- Vanity Domain