Zscaler OneAPI

Zscaler OneAPI

WitnessAI Documentation
List
Start Here
Home
Discovery
Analytics
Conversations
Users
Alerts
Policy
Administration
Apps & Resources
Tutorials
Release Notes
Release Notes
November 3, 2026 WitnessAI Release
October 27, 2026 WitnessAI Release
October 20, 2026: WitnessAI Release
October 13, 2026: WitnessAI Release
September 29, 2026: WitnessAI Release
September 22, 2026: WitnessAI Release
September 15, 2026: WitnessAI Release
September 8, 2026: WitnessAI Release
September 1, 2026: WitnessAI Release
August 25, 2026: WitnessAI Release
August 18, 2026 WitnessAI Release
August 4, 2026 WitnessAI Release
July 21, 2026 WitnessAI Release
July 14, 2026 WitnessAI Release
July 9, 2026 WitnessAI Release
June 30, 2026 WitnessAI Hotfix
June 23, 2026 WitnessAI Release
June 16, 2026 WitnessAI Release
June 11, 2026 WitnessAI Release
June 4, 2026 WitnessAI Hotfix
June 2, 2026 WitnessAI Update
May 19, 2026 WitnessAI Update
April 30, 2026 WitnessAI Update
April 28, 2026 WitnessAI Update
April 23, 2026 WitnessAI Update
April 16, 2026 WitnessAI Update
April 14, 2026 WitnessAI Update
April 9, 2026 WitnessAI Update
April 2, 2026 WitnessAI Update
March 31, 2026 WitnessAI Update
March 24, 2026 WitnessAI Update
March 19, 2026 WitnessAI Update
March 17, 2026 WitnessAI Update
March 12, 2026 WitnessAI Update
March 5, 2026 WitnessAI Update
February 26, 2026 WitnessAI Update
February 24, 2026 WitnessAI Update
February 10, 2026 WitnessAI Update
January 27, 2026 WitnessAI Update
January 20, 2026 WitnessAI Update
January 13, 2026 WitnessAI Update
December 18, 2025 WitnessAI Update
December 9, 2025 WitnessAI Update
November 18, 2025 WitnessAI Update
November 25, 2025 WitnessAI Update
November 11, 2025 WitnessAI Update
October 28, 2025 WitnessAI Update
October 23, 2025 WitnessAI Update
October 9, 2025 WitnessAI Update
April 11, 2025: WitnessAI Release v2.0
Draft: November 10, 2026 WitnessAI Release
June 9, 2025: WitnessAI Update
June 23, 2025: WitnessAI Update
July 18, 2025: WitnessAI Update
September 30, 2025: WitnessAI Update
July 31, 2025: WitnessAI Update
August 12, 2025: WitnessAI Update
September 23, 2025: WitnessAI Update
October 2, 2025 WitnessAI Update
Integrations
API Reference
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
notion image
 

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)
notion image
  • 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
notion image
  • Save → Zidentity auto-generates the Client ID, shown on the API Clients page. Copy it.
notion image
 

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
notion image
Once the above configuration is completed, please hand over the below details to the WitnessAI account team:
  • Client ID
  • Client Secret
  • Vanity Domain