Zscaler OAuth2 Lookup URL
Browse: 🏠 · Solutions · Connectors · Methods · Tables · Content · Parsers · ASIM Parsers · ASIM Products · 📊
This playbook looks up URL categorization information from Zscaler using OAuth2 authentication.
| Attribute | Value |
|---|---|
| Type | Playbook |
| Solution | Zscaler Internet Access |
| Source | View on GitHub |
Additional Documentation
📄 Source: Oauth2LookupURL/readme.md
This playbook enables automated URL classification lookup in Zscaler Internet Access (ZIA) when triggered by Microsoft Sentinel incidents. It uses OAuth2 authentication to securely query the Zscaler API and retrieve URL category information for URLs found in incidents.
Overview
The Zscaler-Oauth2-LookupURL playbook is designed to:
- Automatically extract URL entities from Microsoft Sentinel incidents
- Authenticate with Zscaler ZIA using OAuth2 via the authentication playbook
- Query Zscaler's URL lookup API to retrieve classification information for each URL
- Return URL classifications and security alert categories for enrichment purposes
Prerequisites
Before deploying this playbook, ensure you have:
- A Zscaler Internet Access (ZIA) subscription with API access enabled
- The Zscaler-Oauth2-Authentication playbook deployed in the same resource group
- OAuth2 client credentials (Client ID and Client Secret) configured in Azure Key Vault
- Appropriate permissions to deploy Azure Logic Apps
Deployment
Click the button below to deploy the Zscaler-Oauth2-LookupURL playbook to your Azure environment:
Post-Deployment Configuration
After deployment, complete the following steps:
-
Authorize API Connections - Navigate to the Logic App in the Azure portal - Go to API connections and authorize the Microsoft Sentinel connection - Ensure the managed identity has appropriate permissions
-
Grant Required Permissions - Assign the Logic App managed identity the "Microsoft Sentinel Responder" role on your workspace - Verify the Zscaler-Oauth2-Authentication playbook is deployed and accessible
-
Configure Zscaler API URL (Optional) - The default Base URL is "zsapi.zscaler.net/api/v1" - To change, edit the playbook and update the "Initialize_variable" action for BaseURL
-
Configure Automation Rules - Create automation rules in Microsoft Sentinel to trigger this playbook - Configure rules to run on incidents containing URL entities
Parameters
| Parameter | Description | Default Value |
|---|---|---|
| PlaybookName | Name of the Logic App | Zscaler-Oauth2-LookupURL |
Workflow
- Triggered by Microsoft Sentinel incident creation
- Extracts URL entities from the incident
- Initializes the Zscaler API Base URL variable
- Calls the Zscaler-Oauth2-Authentication playbook to obtain an access token
- For each URL, queries the Zscaler URL lookup API (
/urlLookup) - Parses the response containing:
-
url: The queried URL -urlClassifications: Array of URL category classifications -urlClassificationsWithSecurityAlert: Security-related classifications - URLs are processed sequentially (concurrency set to 1) for reliable execution
Learn More
- Zscaler API Documentation
- URL Lookup API
- API Developers Guide: Getting Started
- Microsoft Sentinel Playbooks
Browse: 🏠 · Solutions · Connectors · Methods · Tables · Content · Parsers · ASIM Parsers · ASIM Products · 📊