SOAR table of contents

Click soar at the top of each SOAR document to return to this table of contents.

Get started

Google SecOps SOAR overview

Get started with Google SecOps SOAR

Navigate the Google SecOps SOAR platform

Configure user preferences

Gemini in Google SecOps overview

Release plan for Google SecOps

Administer

Set up an instance

Onboard Google SecOps SOAR

Locate your customer ID

Provide access to Google Support

Configure SOAR access

Overview

Manage SOC roles

SOAR API overview

Authenticate to legacy SOAR API

Manage permission groups

Overview

Understand user groups

Work with Managed and Managed-Plus user groups

Work with collaborator user groups

Manage environments

Overview

Manage environment groups

Configure custom environment groups

Manage user accounts and access

Apply multiple control access parameters

View all users

Configure instance settings

Manage operational settings

Define a landing page

Rebrand your platform

Set time zone

Configure email settings

Configure SOAR data retention

Monitor SOAR activity

Service limits

Manage administrative assets

Create custom lists

Create email HTML templates

Create email templates

Add variables to email templates

Create user requests

Manage properties metadata

Manage statistics

Retrieve raw Python logs

Manage case settings

Manage case stages

Configure case naming conventions

Create custom fields for cases

Manage custom case closure fields

Configure the close case dialog

Configure the default case view

Set the SLA

Manage alert settings

Configure alert grouping

Configure alert overflow

Configure the default alert view

Exclude entities from alerts

Manage case and alert tags

Configure networks and multi-tenancy

Manage networks

Define domains for MSSPs

Manage environment load balancing

Migrate SOAR to Google Cloud

Overview

Pre-migration validation guide

Manage MSSP migration

Migrate SOAR permissions to IAM

Map SOAR permissions to IAM

Migrate to Chronicle API

SOAR API mapping table

Work with Chronicle API list operations

Migrate remote agent authentication infrastructure

Authenticate remote agents with Workload Identity Federation

Frequently asked questions

Build and integrate

Deploy centralized content

Run use cases from the Content Hub

Power ups and utilities

Connectors

Email utilities

Enrichment

File utilities

Functions

Image utilities

TemplateEngine

Insights

Lists

Tools

Develop custom capabilities

Use the IDE

SOAR SDK overview

Get started

Develop your first custom integration

Develop your first custom action

Develop your first email connector

Develop your first use case

Build and design custom components

Build custom integrations

Create custom actions

Write automated jobs

Create a custom connector

Publish custom integrations

Build and configure connectors

Build connector logic

Configure custom connectors

Test custom connectors

Map and model alerts

Advanced data modeling

Develop custom transformers

Configure calculated fields for cases

Manage response integrations

Configure response integrations

Roll back response integrations

Upgrade the Python version

Manage integration dependencies

Support multiple instances

Test response integrations

Manage secrets with secret managers

Contribute community response integrations

Manage remote agents

Get started

Overview

Review deployment requirements

Review data flow and protocols

Remote agent security

Deploy remote agents

Deploy with Docker

Deploy with Podman

Deploy on Debian

Deploy on RHEL

Deploy on CentOS

Configure high availability

Redeploy connectors

Configure Workload Identity Federation

Configure and validate connectivity

Configure the installer and Docker

Configure remote execution

Test the connection flow

Manage and upgrade remote agents

Remote agent scaling strategy

Monitor and manage remote agents

Perform a standard upgrade

Major upgrade with Docker

Major upgrade with Podman

Major upgrade with RHEL

Major upgrade with CentOS

Redeploy remote agents

Troubleshoot remote agents

Ingest

Collect data

Ingest data using SOAR connectors

Define environments in SOAR connectors

Map custom date and time in Elasticsearch

View SOAR connector logs

Set up a SOAR webhook

Manage alert and event ontology

Ontology overview

Map and model entities

Visual families overview

Configure mapping and assign visual families

Configure entity delimiters

Analyze and respond

Create and triage cases

Case management overview

Create a case manually

Manage cases from the case queue

Manage large alerts

Change alert priority

Relocate cases between environments

Investigate cases and alerts

Summarize cases with Gemini

Collaborate using case chat

Explore the cases page

Explore the case overview tab

Review alert highlights and context

Investigate entities and alerts

View SIEM data in a case

Navigate the Entity Explorer page

Manage entity properties

Filter case and alert data

Perform entity selection

Manage cases

Analyze event details

Respond and resolve

Track case tasks

Your workdesk overview

Submit requests from your workdesk

Respond to pending actions from your workdesk

Monitor cases from your workdesk

Search cases and entities

Resolve and close cases

Monitor case response and closure metrics

Validate case workflows with test cases

Automate

Automation foundations

Playbook automation overview

Use the playbook navigator

Build and design playbooks

Create your first playbook

Case playbooks overview

Manage playbooks with Gemini

Manage playbook triggers

Use reaction triggers in playbooks

Trigger playbooks by alert type

Manage playbook actions

Manage playbook flows

Work with playbook blocks

Automate tasks with playbook loops

Attach playbooks to alerts and cases

Configure custom alert views

Configure the HTML widget

Configure predefined widgets in playbook views

Configure playbook logic and behavior

Build logic with the Expression Builder

Specify an instance in dynamic mode

Configure timeouts for async actions

Configure parallel actions

Configure automatic retries

Assign actions and playbook blocks

Assign approval links in actions

Manage and monitor playbooks

Manage playbook permissions

Review and manage alert playbook execution

Rerun automated playbooks

Manage bulk actions and filters in playbooks

Monitor playbook performance

Test playbooks with the simulator

Use cases and examples

Explore playbook use cases

Expression Builder examples

Create a fallback playbook

Create an enrichment playbook block

Monitor and troubleshoot

Troubleshoot system issues

Troubleshoot remote agents

Troubleshoot SOAR functionality

View connector logs

Collect SOAR platform logs

Manage dashboards and reporting

Curated dashboard queries by data source

SOAR data foundations for dashboards

Query SOAR cases

Query SOAR case history

Query SOAR playbooks

Legacy SOAR dashboards and reports

Legacy SOAR dashboards overview

Add SOAR dashboard widgets

Explore the SOAR dashboards page

Explore legacy SOAR reports

Work with SOAR reports

SOAR BigQuery schema reference

Administer SOAR standalone instances

Configure authentication

Authenticate users

Configure Google Workspace for SAML

Configure Microsoft Azure for SAML

Configure Okta for SAML

Configure multiple SAML providers

Troubleshoot SAML issues

Manage users and access

Manage SOAR standalone users

Invite users to the platform

Create a managed user

Create a collaborator user

Create a view-only user

Delete a user account

Manage password policy

Configure just-in-time user provisioning

Map IdP groups for SOAR standalone access

Administration and content tasks

Configure case federation for SOAR standalone

Use the Content Hub for SOAR standalone

Deprovision a SOAR standalone instance