Vectra Add Tag To Entity Selected Detections

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

↑ Back to Content Index

This playbook enables users to add tags to selected detections associated with an entity. Users can provide inputs of detections selection and tags value via Microsoft Teams.

Attribute Value
Type Playbook
Solution Vectra XDR
Source View on GitHub

Logic App Connectors

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

Connector / Action Type Connections Actions
azuresentinel Managed 1 0
keyvault Managed 1 3
teams Managed 1 1
http Built-in 0 3
workflow Built-in 0 3
Action parameters (URLs, paths, function IDs)

keyvault (Managed)

Action Method Endpoint Other
Get_Access_Token_For_Each_Detection get /secrets/@{encodeURIComponent('Vectra-Access-Token')}/value —
Get_Access_Token_For_Fetching_Tags get /secrets/@{encodeURIComponent('Vectra-Access-Token')}/value —
Get_Access_Token get /secrets/@{encodeURIComponent('Vectra-Access-Token')}/value —

teams (Managed)

Action Method Endpoint Other
Post_Message_in_Chat_For_No_Detections_Found post /beta/teams/conversation/message/poster/Flow bot/location/@{encodeURIComponent('Channel')} —

http (Built-in)

Action Method Endpoint Other
HTTP_Request_To_Add_Tags_To_Detection PATCH @{variables('base_url')}/api/@{variables('api_version')}/tagging/detection/@{int(items('For_Each_Detections'))} —
HTTP_Request_To_Fetch_Detection_Tags GET @{variables('base_url')}/api/@{variables('api_version')}/tagging/detection/@{items('For_Each_Detections')} —
HTTP_Request_To_Fetch_Detections_Data_For_Associated_Entity GET @{variables('base_url')}/api/@{variables('api_version')}/detections —

workflow (Built-in)

Action Method Endpoint Other
GenerateAccessTokenVectra_2 — — workflowId=[concat('/subscriptions/', subscription().subscriptionId, '/resourceGroups/',resourceGroup().name,'/providers/Microsoft.Logic/workflows/',trim(parameters('GenerateAccessCredPlaybookName')))]
triggerName=manual
GenerateAccessTokenVectra_3 — — workflowId=[concat('/subscriptions/', subscription().subscriptionId, '/resourceGroups/',resourceGroup().name,'/providers/Microsoft.Logic/workflows/',trim(parameters('GenerateAccessCredPlaybookName')))]
triggerName=manual
GenerateAccessTokenVectra — — workflowId=[concat('/subscriptions/', subscription().subscriptionId, '/resourceGroups/',resourceGroup().name,'/providers/Microsoft.Logic/workflows/',trim(parameters('GenerateAccessCredPlaybookName')))]
triggerName=manual

Additional Documentation

📄 Source: VectraAddTagToEntitySelectedDetections/readme.md

Summary

This playbook enables users to add tags to selected detections associated with an entity. Users can provide inputs via Microsoft Teams.

Prerequisites

  1. Obtain Key Vault name and Tenant ID where client credentials are stored using which access token will be generated.
    • Create a Key Vault with a unique name.
    • Go to Key Vaults → your Key Vault → Overview and copy Directory ID, which will be used as the tenant ID. NOTE: Ensure the Permission model in the Access Configuration of Key Vault is set to 'Vault access policy'.
  2. Obtain Teams GroupId and ChannelId.
    • Create a Team with a public channel.
    • Click on the three dots (...) next to your newly created Teams channel and select Get link to channel.
    • Copy the text from the link between /channel and /, decode it using an online URL decoder, and copy it to use as Channel ID.
    • Copy the text of the GroupId parameter from the link to use as GroupId.
  3. Ensure the VectraGenerateAccessToken playbook is deployed before deploying VectraAddTagToEntitySelectedDetections playbook.

Deployment Instructions

  1. To deploy the Playbook, click the Deploy to Azure button. This will launch the ARM Template deployment wizard.
  2. Fill in the required parameters:
    • PlaybookName: Enter the playbook name here.
    • KeyVaultName: Name of the Key Vault where secrets are stored.
    • TenantId: Tenant ID where the Key Vault is located.
    • BaseURL: Enter the base URL of your Vectra account.
    • TeamsGroupId: Enter Id of the Teams Group where the adaptive card will be posted.
    • TeamsChannelId: Enter Id of the Teams Channel where the adaptive card will be posted.
    • GenerateAccessCredPlaybookName: Playbook name which is deployed as part of prerequisites.

Deploy to Azure Deploy to Azure

Post-Deployment Instructions

a. Authorize connections

Once deployment is complete, authorize each connection.

  1. Go to your logic app → API connections → Select keyvault connection resource.
  2. Go to General → Edit API connection.
  3. Click Authorize.
  4. Sign in.
  5. Click Save.
  6. Repeat steps for other connections.

b. Add Access Policy in Key Vault

Add access policy for the playbook's managed identity and authorized user to read and write secrets of the Key Vault.

  1. Go to Logic App → your Logic App → Identity → System assigned Managed identity and copy Object (principal) ID.
  2. Go to Key Vaults → your Key Vault → Access policies → Create.
  3. Select all keys & secrets permissions. Click Next.
  4. In the principal section, search by copied Object ID. Click Next.
  5. Click Review + Create.
  6. Repeat steps 2 to 5 to add access policy for the user account used to authorize the connection.

c. Configurations in Microsoft Sentinel

  1. In Microsoft Sentinel, the analytical rule should be configured to trigger an incident based on data ingested from Vectra. Incident should have Entity mapping.
  2. To manually run the playbook on a particular incident, follow the steps below:
    • Go to Microsoft Sentinel → your workspace → Incidents.
    • Select an incident.
    • In the right pane, click on Actions, and from the dropdown select the Run Playbook option.
    • Click on the Run button beside this playbook.

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

↑ Back to Playbooks · Back to Vectra XDR