Vectra Assign Static User To Entity

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

↑ Back to Content Index

This playbook will assign a predefined user to an entity in Vectra when the status of an incident changes from 'New' to 'Active'.

Attribute Value
Type Playbook
Solution Vectra XDR
Source View on GitHub

Logic App Connectors

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

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

keyvault (Managed)

Action Method Endpoint Other
Get_Access_Token_For_Assigning_User_To_Entity get /secrets/@{encodeURIComponent('Vectra-Access-Token')}/value —
Get_Access_Token_For_Reassigning_User_To_Entity get /secrets/@{encodeURIComponent('Vectra-Access-Token')}/value —
Get_Access_Token_For_Host_Entity get /secrets/@{encodeURIComponent('Vectra-Access-Token')}/value —
Get_Access_Token_For_Account_Entity get /secrets/@{encodeURIComponent('Vectra-Access-Token')}/value —

http (Built-in)

Action Method Endpoint Other
HTTP_Request_To_Assign_Static_User_To_Entity_In_Vectra POST @{variables('base_url')}/api/@{variables('api_version')}/assignments —
HTTP_Request_To_Reassign_Static_User_To_Entity_In_Vectra PUT @{variables('base_url')}/api/@{variables('api_version')}/assignments/@{variables('assignment_id')} —
HTTP_Request_To_Fetch_Associated_Host_Entity_Data GET @{variables('base_url')}/api/@{variables('api_version')}/hosts/@{int(variables('entity_id'))} —
HTTP_Request_To_Fetch_Associated_Account_Entity_Data GET @{variables('base_url')}/api/@{variables('api_version')}/accounts/@{int(variables('entity_id'))} —

workflow (Built-in)

Action Method Endpoint Other
GenerateAccessTokenVectra — — workflowId=[concat('/subscriptions/', subscription().subscriptionId, '/resourceGroups/',resourceGroup().name,'/providers/Microsoft.Logic/workflows/',trim(parameters('GenerateAccessCredPlaybookName')))]
triggerName=manual
GenerateAccessTokenVectra_4 — — workflowId=[concat('/subscriptions/', subscription().subscriptionId, '/resourceGroups/',resourceGroup().name,'/providers/Microsoft.Logic/workflows/',trim(parameters('GenerateAccessCredPlaybookName')))]
triggerName=manual
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

Additional Documentation

📄 Source: VectraAssignStaticUserToEntity/readme.md

Summary

This playbook will assign a predefined user to an entity in Vectra when the status of an incident changes from 'New' to 'Active'.

Prerequisites

  1. The Vectra XDR data connector should be configured to create alerts and generate an incident based on entity data in Microsoft Sentinel.
  2. Obtain the Key Vault name and Tenant ID where client credentials are stored using which the 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'.
  3. Make sure that the VectraGenerateAccessToken playbook is deployed before deploying the VectraAssignStaticUserToEntity 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.
    • UserId: Enter a user id which will be assign to entity.
    • 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 the Key Vault 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 using which connection is authorized.

c. Configurations in Microsoft Sentinel

  1. In Microsoft Sentinel, analytical rule should be configured to trigger an incident based on data ingested from Vectra. Incident should have Entity mapping.
  2. In Microsoft Sentinel, Configure the automation rules to trigger the playbook.
    • Go to Microsoft Sentinel → your workspace → Automation.
    • Click on Create → Automation rule.
    • Provide a name for your rule.
    • Select Trigger as When incident is updated.
    • In Conditions, select Status changed from 'New' and status changed to 'Active'.
    • In Actions dropdown, select Run playbook.
    • In the second dropdown, select your deployed playbook.
    • Click on Apply.
    • Save the Automation rule.

NOTE: If you want to manually run the playbook on a particular incident, follow the below steps:

  1. Go to Microsoft Sentinel → your workspace → Incidents.
  2. Select an incident.
  3. In the right pane, click on Actions, and from the dropdown select the 'Run Playbook' option.
  4. 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