Vectra Close Detections

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

↑ Back to Content Index

This playbook enables user to close detections associated with a Vectra Entity with reason as Remediated or Benign. User can add detection ids in comments along with the reason to close the detections in the associated incident else if no comments found, users can provide detection ids via MS Teams.

Attribute Value
Type Playbook
Solution Vectra XDR
Source View on GitHub

Additional Documentation

📄 Source: VectraCloseDetections/readme.md

Summary

This playbook enables users to close detections with reason associated with a Vectra Entity. Users can add detection IDs in comments of the associated incident or, if no comments are found, users can provide detection IDs via Microsoft Teams Card.

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 VectraCloseDetections 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 Gov

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. Assign Role to update incident

After authorizing each connection, assign role to this playbook. 1. Go to Log Analytics Workspace → your workspace → Access Control → Add. 2. Add role assignment. 3. Assignment type: Job function roles. 4. Role: Microsoft Sentinel Contributor. 5. Members: select managed identity for assigned access to and add your logic app as member. 6. Click on review+assign.

d. 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.

e. Note

  1. In Microsoft Sentinel Incident, the comment should contain detection IDs along with the reason to close the detections in the following format to be able to extract values from it. * close_dets: id1,id2,id3 (Comma-separated detection IDs without quotes) * reason: remediated (Allowed values are remediated or benign, Default: remediated) * close_dets: All (Use 'All' keyword with specified format to close all detections) * Multiple detection IDs are supported from the comment. If no comments are found, users can provide detection IDs via the adaptive card option instead.

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

↑ Back to Playbooks · Back to Vectra XDR