Zscaler OAuth2 Unblock URL

Browse: 🏠 · Solutions · Connectors · Methods · Tables · Content · Parsers · ASIM Parsers · ASIM Products · Logic Apps · 📊

↑ Back to Content Index

This playbook unblocks URLs in Zscaler by removing them from a category using OAuth2 authentication.

Attribute	Value
Type	Playbook
Solution	Zscaler Internet Access
Source	View on GitHub

Logic App Connectors

This playbook uses 3 Logic App connectors / built-in actions:

Connector / Action	Type	Connections	Actions
`azuresentinel`	Managed	1	2
`http`	Built-in	0	2
`workflow`	Built-in	0	1

Action parameters (URLs, paths, function IDs)

`azuresentinel` (Managed)

Action	Method	Endpoint	Other
Entities_-_Get_URLs	post	`/entities/url`	—
Add_comment_to_incident_(V3)	post	`/Incidents/Comment`	—

`http` (Built-in)

Action	Method	Endpoint	Other
HTTP_Remove_URL	PUT	`https://api.zsapi.net/zia/api/v1/urlCategories/@{variables('Category')}?action=REMOVE_FROM_LIST`	—
HTTP_Activate_Changes	POST	`https://api.zsapi.net/zia/api/v1/status/activate`	—

`workflow` (Built-in)

Action	Method	Endpoint	Other
zscaler	—	—	workflowId=`[variables('ZscalerAuthenticationFlow')]` triggerName=`manual`

Additional Documentation

📄 Source: Oauth2UnblockURL/readme.md

This playbook enables automated removal of URLs from a Zscaler Internet Access (ZIA) block category when triggered by Microsoft Sentinel incidents. It uses OAuth2 authentication to securely communicate with the Zscaler API and remove URLs from the designated URL category.

Overview

The Zscaler-Oauth2-UnblockURL playbook is designed to:

Automatically extract URL entities from Microsoft Sentinel incidents
Authenticate with Zscaler ZIA using OAuth2 via the authentication playbook
Remove URLs from a specified Zscaler URL category
Process multiple URLs sequentially to ensure reliable API communication

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
A URL category in Zscaler containing the URLs to be removed (default: "OTHER_MISCELLANEOUS")
Appropriate permissions to deploy Azure Logic Apps

Deployment

Click the button below to deploy the Zscaler-Oauth2-UnblockURL 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 URL Category (Optional)
- The default category is "OTHER_MISCELLANEOUS"
- To change, edit the playbook and update the "Define_URL_Category" action
Configure Zscaler API URL (Optional)
- The default Base URL is "zsapi.zscaler.net/api/v1"
- To change, edit the playbook and update the "Define_Base_URL" action
Configure Automation Rules
- Create automation rules in Microsoft Sentinel to trigger this playbook
- Configure rules to run on incidents containing URL entities that need to be unblocked

Parameters

Parameter	Description	Default Value
PlaybookName	Name of the Logic App	Zscaler-Oauth2-UnblockURL

Workflow

Triggered by Microsoft Sentinel incident creation
Extracts URL entities from the incident
Initializes the URL Category variable (default: OTHER_MISCELLANEOUS)
Initializes the Zscaler API Base URL variable
Calls the Zscaler-Oauth2-Authentication playbook to obtain an access token
For each URL, removes it from the configured Zscaler URL category using the API (/urlCategories/{category}?action=REMOVE_FROM_LIST)
URLs are processed sequentially (concurrency set to 1) for reliable execution

Learn More