Skip to main content

Google SecOps Cases

This Integration is part of the Google SecOps Pack.#

Supported versions

Available on Cortex XSOAR (versions 6.10.0 and later) and Cortex XSIAM.

Use the Google SecOps Cases integration to retrieve Cases as Incidents. This integration also provides commands to manage the Cases lifecycle. This integration was integrated and tested with version v1 Alpha of Google SecOps API.

Configure Google SecOps Cases in Cortex#

ParameterDescriptionRequired
User's Service Account JSONTrue
API URL FormatSelect the API URL format to use for API requests. Default value is '<chronicle>.<REGION>.<rep.googleapis.com>'.False
Google SecOps Project Instance IDProvide the Project Instance ID of the Google SecOps.

Note: User can retrieve the Customer ID(Project Instance ID) in the Profile section of the Google SecOps page.
True
Google SecOps Project NumberProvide the Project Number of the Google SecOps.

Note: User can retrieve the Project Number in the Profile section of the Google SecOps page. If Project Number is not provided, then Project ID(from Service Account JSON) will be used.
False
RegionSelect the region based on the location of the Google SecOps instance. If the region is not listed in the dropdown, choose the "Other" option and specify the region in the "Other Region" text field.True
Other RegionSpecify the region based on the location of the Google SecOps instance. Only applicable if the "Other" option is selected in the Region dropdown.False
Fetch incidents
Incident typeFalse
First Fetch TimeThe UTC date or relative timestamp from where to start fetching incidents. Default is 3 days.

Note: If the value is greater than the past 7 days, it will be considered as past 7 days. The maximum is 7 days.

Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 01 May 2026 04:45:33, 2026-05-17T14:05:44Z.
False
How many incidents to fetch each timeThe maximum number of incidents to fetch in each time. Default is 50.

Note: If the value is greater than 200, it will be considered as 200. The maximum is 200.
False
Case PrioritiesFilter cases by priority level. Default is all.False
Case StatusesFilter cases by status. Default is all.False
Case EnvironmentsFilter cases by logical environment.False
Case TagsFilter cases by tag name.False
Case Filter LogicLogical operator to combine the case filter parameters. Default is AND.False
Trust any certificate (not secure)False
Use system proxy settingsFalse

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

gcb-case-list#


Retrieve the list of cases.

Base Command#

gcb-case-list

Input#

Argument NameDescriptionRequired
display_nameFilter the cases by display name. Supports comma-separated values.Optional
priorityFilter the cases by priority. Supports comma-separated values. Possible values are: UNSPECIFIED, INFO, LOW, MEDIUM, HIGH, CRITICAL.Optional
statusFilter the cases by status. Supports comma-separated values. Possible values are: OPENED, CLOSED, MERGED, CREATION_PENDING, CASE_DATA_STATE_UNSPECIFIED.Optional
typeFilter the cases by type. Supports comma-separated values. Possible values are: EXTERNAL, TEST, REQUEST, CASE_TYPE_UNSPECIFIED.Optional
stageFilter the cases by stage. Supports comma-separated values. Possible values are: Triage, Incident, Investigation.Optional
sourceFilter the cases by source. Supports comma-separated values. Possible values are: Server, User, Simulated, Merge, AlertMove.Optional
assigneeFilter the cases by assignee user email or SOC role. Supports comma-separated values.Optional
environmentFilter the cases by environment assigned to the case. Supports comma-separated values.Optional
tagsFilter the cases by tag names. Supports comma-separated values.Optional
productsFilter the cases by product name. Supports comma-separated values.Optional
importantFilter the cases by the importance flag. Possible values are: True, False.Optional
incidentFilter the cases by the incident flag. Possible values are: True, False.Optional
workflow_statusFilter the cases by playbook or workflow execution status. Supports comma-separated values. Possible values are: NONE, IN_PROGRESS, COMPLETED, FAILED, TERMINATED, PENDING_IN_QUEUE, PENDING_FOR_USER, WORKFLOW_STATUS_UNSPECIFIED.Optional
slaFilter the cases by SLA expiration status. Supports comma-separated values. Possible values are: OPEN_SLA, PASSED_DUE, NO_SLA, CRITICAL_EXPIRED, PAUSED, SLA_EXPIRATION_STATUS_UNSPECIFIED.Optional
alerts_slaFilter the cases by the aggregated alerts SLA expiration status. Supports comma-separated values. Possible values are: OPEN_SLA, PASSED_DUE, NO_SLA, CRITICAL_EXPIRED, PAUSED, SLA_EXPIRATION_STATUS_UNSPECIFIED.Optional
create_start_timeFilter the cases created on or after this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
create_end_timeFilter the cases created on or before this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
update_start_timeFilter the cases updated on or after this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
update_end_timeFilter the cases updated on or before this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
advanced_filterSpecify a raw AIP-160 filter string for advanced conditions. When provided, all other individual filter arguments are ignored.

Supported values: displayName, creatorUserId, creatorUser, assignee, stage, status, priority, important, type, environment, score, alertsSla.expirationStatus, sla.expirationStatus, tags, products, closureDetails, tasks, workflowStatus, createTime, updateTime

Example: (priority="PRIORITY_HIGH" OR status="OPENED") AND stage="Investigation".
Optional
page_sizeSpecify the maximum number of cases to return.

Note: Maximum value is 1000. Default is 50.
Optional
page_tokenSpecify the page token for pagination.

Note: Use the next_page_token from a previous gcb-case-list response.
Optional
sort_bySpecify the field to sort results by. Possible values are: displayName, priority, stage, status, score, createTime, updateTime, assignee, environment, type, sla.expirationTime, alertsSla.expirationTime, sla.expirationStatus, alertsSla.expirationStatus, workflowStatus. Default is createTime.Optional
sort_orderSpecify the sort direction for the results. Possible values are: Asc, Desc. Default is Desc.Optional
filter_logicSpecify the logical operator to combine filter conditions. Possible values are: AND, OR. Default is AND.Optional

Context Output#

PathTypeDescription
GoogleSecOps.Case.nameStringThe unique resource name of the Case.
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.displayNameStringThe title of the Case.
GoogleSecOps.Case.creatorUserIdStringThe ID of the user who created the Case.
GoogleSecOps.Case.lastModifyingUserIdStringThe ID of the user who last modified the Case.
GoogleSecOps.Case.createTimeStringThe creation time of the Case (unix epoch milliseconds).
GoogleSecOps.Case.updateTimeStringThe last update time of the Case (unix epoch milliseconds).
GoogleSecOps.Case.alertCountNumberThe number of alerts linked to the Case.
GoogleSecOps.Case.stageStringThe current workflow stage of the Case.
GoogleSecOps.Case.priorityStringThe priority of the Case.
GoogleSecOps.Case.assigneeStringThe assigned user or SOC role of the Case.
GoogleSecOps.Case.descriptionStringThe description of the Case.
GoogleSecOps.Case.typeStringThe type of the Case.
GoogleSecOps.Case.environmentStringThe logical environment of the Case.
GoogleSecOps.Case.statusStringThe status of the Case.
GoogleSecOps.Case.scoreNumberThe attack exposure score of the Case.
GoogleSecOps.Case.workflowStatusStringThe playbook or workflow status of the Case.
GoogleSecOps.Case.sourceStringThe source that created the Case.
GoogleSecOps.Case.importantBooleanWhether the Case is marked as important.
GoogleSecOps.Case.incidentBooleanWhether the Case is marked as an incident.
GoogleSecOps.Case.overflowCaseBooleanWhether the Case is an overflow case due to large data volume.
GoogleSecOps.Case.involvedSuspiciousEntityBooleanWhether a suspicious entity is involved in the Case.
GoogleSecOps.Case.sla.expirationTimeStringThe SLA expiration time of the Case (unix ms).
GoogleSecOps.Case.sla.criticalExpirationTimeStringThe SLA critical expiration time of the Case (unix ms).
GoogleSecOps.Case.sla.expirationStatusStringThe SLA expiration status of the Case.
GoogleSecOps.Case.sla.remainingTimeSinceLastPauseNumberThe remaining time since the last SLA pause of the Case.
GoogleSecOps.Case.alertsSla.expirationTimeStringThe aggregated alerts SLA expiration time of the Case (unix ms).
GoogleSecOps.Case.alertsSla.criticalExpirationTimeStringThe aggregated alerts SLA critical expiration time of the Case (unix ms).
GoogleSecOps.Case.alertsSla.expirationStatusStringThe aggregated alerts SLA expiration status.
GoogleSecOps.Case.alertsSla.remainingTimeSinceLastPauseNumberThe remaining time since the last alerts SLA pause of the Case.
GoogleSecOps.Case.tags.displayNameStringThe display name of the tag.
GoogleSecOps.Case.tags.priorityNumberThe priority order of the tag.
GoogleSecOps.Case.products.displayNameStringThe display name of the product.
GoogleSecOps.Case.products.alertStringThe resource name of the alert associated with the product.
GoogleSecOps.Case.tasks.idStringThe ID of the task.
GoogleSecOps.Case.tasks.titleStringThe title of the task.
GoogleSecOps.Case.tasks.contentStringThe content/description of the task.
GoogleSecOps.Case.tasks.statusStringThe status of the task.
GoogleSecOps.Case.tasks.assigneeStringThe assignee of the task.
GoogleSecOps.Case.tasks.authorStringThe author who created the task.
GoogleSecOps.Case.tasks.lastAuthorStringThe last user who modified the task.
GoogleSecOps.Case.tasks.createTimeStringThe creation time of the task (unix epoch milliseconds).
GoogleSecOps.Case.tasks.updateTimeStringThe last update time of the task (unix epoch milliseconds).
GoogleSecOps.Case.tasks.caseIdNumberThe ID of the Case the task belongs to.
GoogleSecOps.Case.tasks.favoriteBooleanWhether the task is marked as a favorite.
GoogleSecOps.Case.closureDetails.reasonStringThe closure reason of the Case.
GoogleSecOps.Case.closureDetails.commentStringThe closure comment of the Case.
GoogleSecOps.Case.closureDetails.rootCauseStringThe root cause provided at closure.
GoogleSecOps.Case.closureDetails.caseClosedActionStringThe action taken when the Case was closed.
GoogleSecOps.PageToken.commandStringThe command name associated with the pagination token.
GoogleSecOps.PageToken.nextPageTokenStringThe token to retrieve the next page of Cases.
GoogleSecOps.PageToken.totalSizeNumberThe total number of cases available.

Command example#

!gcb-case-list page_size=10 priority="HIGH,CRITICAL" status=OPENED stage=Triage assignee=@SOC sort_by=createTime sort_order=Desc

Context Example#

{
"GoogleSecOps": {
"Case": [
{
"name": "projects/chronicle-mock-proj/locations/us/instances/00000000-0000-0000-0000-000000000001/cases/1001",
"caseId": "1001",
"displayName": "Test Case 1",
"lastModifyingUserId": "00000000-0000-0000-0000-000000000002",
"createTime": "1778778979232",
"updateTime": "1779426987796",
"alertCount": 15,
"stage": "Triage",
"priority": "PRIORITY_MEDIUM",
"assignee": "@Tier1",
"type": "EXTERNAL",
"environment": "Default Environment",
"status": "OPENED",
"workflowStatus": "PENDING_FOR_USER",
"source": "Server",
"important": false,
"incident": false,
"overflowCase": false,
"involvedSuspiciousEntity": false,
"sla": {
"expirationTime": "1780832620238",
"criticalExpirationTime": "1780580620238",
"expirationStatus": "OPEN_SLA"
},
"alertsSla": {
"expirationTime": "1782774000000",
"expirationStatus": "OPEN_SLA"
},
"tags": [
{
"displayName": "demo 1",
"priority": 0
},
{
"displayName": "demo 2",
"priority": 1
}
],
"products": [
{
"displayName": "Test Case",
"alert": "alert 1"
},
{
"displayName": "Test Case",
"alert": "alert 2"
}
],
"tasks": [
{
"id": "3",
"createTime": "1779447705049",
"updateTime": "1779447705049",
"content": "Testing",
"title": "XSOAR testing",
"author": "00000000-0000-0000-0000-000000000001",
"lastAuthor": "00000000-0000-0000-0000-000000000002",
"assignee": "00000000-0000-0000-0000-000000000001",
"status": "PENDING",
"favorite": false,
"caseId": 1001
}
],
"closureDetails": {
"reason": "NOT_MALICIOUS",
"rootCause": "False positive from detection rule",
"caseClosedAction": "MANUALLY",
"comment": "Reviewed and confirmed benign activity.\n Case closed by Siemplify API. \nAll attached playbooks and playbook blocks have been terminated.\nAll Alerts were closed."
}
},
{
"name": "projects/chronicle-mock-proj/locations/us/instances/00000000-0000-0000-0000-000000000001/cases/1002",
"caseId": "1002",
"displayName": "Test Case 2",
"lastModifyingUserId": "00000000-0000-0000-0000-000000000003",
"createTime": "1778714179967",
"updateTime": "1779416182426",
"alertCount": 5,
"stage": "Investigation",
"priority": "PRIORITY_HIGH",
"assignee": "00000000-0000-0000-0000-000000000004",
"type": "EXTERNAL",
"environment": "Production",
"status": "OPENED",
"workflowStatus": "IN_PROGRESS",
"source": "Agent",
"important": true,
"incident": false,
"overflowCase": false,
"involvedSuspiciousEntity": true,
"sla": {
"expirationStatus": "NO_SLA"
},
"alertsSla": {
"expirationStatus": "NO_SLA"
},
"tags": [
{
"displayName": "critical",
"priority": 0
}
],
"products": [
{
"displayName": "Test Product",
"alert": "alert 3"
}
]
}
],
"PageToken": {
"command": "gcb-case-list",
"nextPageToken": "next_page_token_value",
"totalSize": 2
}
}
}

Human Readable Output#

Case List#

Case IDDisplay NamePriorityStatusStageEnvironmentWorkflow StatusAssigneeTagsSLAAlert CountCreate Time
1001Test Case 1MEDIUMOPENEDTriageDefault EnvironmentPENDING_FOR_USER@Tier1- displayName: demo 1
priority: 0
- displayName: demo 2
priority: 1
Status: OPEN_SLA
Expiration Time: 2026-06-07 11:43:40 UTC
Critical Expiration Time: 2026-06-04 13:43:40 UTC
152026-05-14 17:16:19 UTC
1002Test Case 2HIGHOPENEDInvestigationProductionIN_PROGRESS00000000-0000-0000-0000-000000000004- displayName: critical
priority: 0
Status: NO_SLA52026-05-13 23:16:19 UTC

Maximum number of cases specified in page_size has been returned. To fetch the next set of cases, execute the command with the page token as next_page_token_value.

gcb-case-get#


Retrieve a specific case by its ID.

Base Command#

gcb-case-get

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.nameStringThe unique resource name of the Case.
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.displayNameStringThe title of the Case.
GoogleSecOps.Case.creatorUserIdStringThe ID of the user who created the Case.
GoogleSecOps.Case.lastModifyingUserIdStringThe ID of the user who last modified the Case.
GoogleSecOps.Case.createTimeStringThe creation time of the Case (unix epoch milliseconds).
GoogleSecOps.Case.updateTimeStringThe last update time of the Case (unix epoch milliseconds).
GoogleSecOps.Case.alertCountNumberThe number of alerts linked to the Case.
GoogleSecOps.Case.stageStringThe current workflow stage of the Case.
GoogleSecOps.Case.priorityStringThe priority of the Case.
GoogleSecOps.Case.assigneeStringThe assigned user or SOC role of the Case.
GoogleSecOps.Case.descriptionStringThe description of the Case.
GoogleSecOps.Case.typeStringThe type of the Case.
GoogleSecOps.Case.environmentStringThe logical environment of the Case.
GoogleSecOps.Case.statusStringThe status of the Case.
GoogleSecOps.Case.scoreNumberThe attack exposure score of the Case.
GoogleSecOps.Case.workflowStatusStringThe playbook or workflow status of the Case.
GoogleSecOps.Case.sourceStringThe source that created the Case.
GoogleSecOps.Case.importantBooleanWhether the Case is marked as important.
GoogleSecOps.Case.incidentBooleanWhether the Case is marked as an incident.
GoogleSecOps.Case.overflowCaseBooleanWhether the Case is an overflow case due to large data volume.
GoogleSecOps.Case.involvedSuspiciousEntityBooleanWhether a suspicious entity is involved in the Case.
GoogleSecOps.Case.sla.expirationTimeStringThe SLA expiration time of the Case (unix ms).
GoogleSecOps.Case.sla.criticalExpirationTimeStringThe SLA critical expiration time of the Case (unix ms).
GoogleSecOps.Case.sla.expirationStatusStringThe SLA expiration status of the Case.
GoogleSecOps.Case.sla.remainingTimeSinceLastPauseNumberThe remaining time since the last SLA pause of the Case.
GoogleSecOps.Case.alertsSla.expirationTimeStringThe aggregated alerts SLA expiration time of the Case (unix ms).
GoogleSecOps.Case.alertsSla.criticalExpirationTimeStringThe aggregated alerts SLA critical expiration time of the Case (unix ms).
GoogleSecOps.Case.alertsSla.expirationStatusStringThe aggregated alerts SLA expiration status.
GoogleSecOps.Case.alertsSla.remainingTimeSinceLastPauseNumberThe remaining time since the last alerts SLA pause of the Case.
GoogleSecOps.Case.tags.displayNameStringThe display name of the tag.
GoogleSecOps.Case.tags.priorityNumberThe priority order of the tag.
GoogleSecOps.Case.products.displayNameStringThe display name of the product.
GoogleSecOps.Case.products.alertStringThe resource name of the alert associated with the product.
GoogleSecOps.Case.tasks.idStringThe ID of the task.
GoogleSecOps.Case.tasks.titleStringThe title of the task.
GoogleSecOps.Case.tasks.contentStringThe content/description of the task.
GoogleSecOps.Case.tasks.statusStringThe status of the task.
GoogleSecOps.Case.tasks.assigneeStringThe assignee of the task.
GoogleSecOps.Case.tasks.authorStringThe author who created the task.
GoogleSecOps.Case.tasks.lastAuthorStringThe last user who modified the task.
GoogleSecOps.Case.tasks.createTimeStringThe creation time of the task (unix epoch milliseconds).
GoogleSecOps.Case.tasks.updateTimeStringThe last update time of the task (unix epoch milliseconds).
GoogleSecOps.Case.tasks.caseIdNumberThe ID of the Case the task belongs to.
GoogleSecOps.Case.tasks.favoriteBooleanWhether the task is marked as a favorite.
GoogleSecOps.Case.closureDetails.reasonStringThe closure reason of the Case.
GoogleSecOps.Case.closureDetails.commentStringThe closure comment of the Case.
GoogleSecOps.Case.closureDetails.rootCauseStringThe root cause provided at closure.
GoogleSecOps.Case.closureDetails.caseClosedActionStringThe action taken when the Case was closed.

Command example#

!gcb-case-get case_id=1001

Context Example#

{
"GoogleSecOps": {
"Case": {
"name": "projects/chronicle-mock-proj/locations/us/instances/00000000-0000-0000-0000-000000000001/cases/1001",
"caseId": "1001",
"displayName": "Test Case",
"lastModifyingUserId": "00000000-0000-0000-0000-000000000002",
"createTime": "1778778979232",
"updateTime": "1779426987796",
"alertCount": 15,
"stage": "Triage",
"priority": "PRIORITY_MEDIUM",
"important": false,
"incident": false,
"assignee": "@Tier1",
"type": "EXTERNAL",
"overflowCase": false,
"environment": "Default Environment",
"status": "OPENED",
"workflowStatus": "PENDING_FOR_USER",
"sla": {
"expirationTime": "1780832620238",
"criticalExpirationTime": "1780580620238",
"expirationStatus": "OPEN_SLA"
},
"alertsSla": {
"expirationTime": "1782774000000",
"expirationStatus": "OPEN_SLA"
},
"source": "Server",
"involvedSuspiciousEntity": false,
"tags": [
{"displayName": "demo 1", "priority": 0},
{"displayName": "demo 2", "priority": 1}
],
"products": [
{"displayName": "Test Case", "alert": "alert 1"},
{"displayName": "Test Case", "alert": "alert 2"}
],
"tasks": [
{
"id": "3",
"createTime": "1779447705049",
"updateTime": "1779447705049",
"content": "Testing",
"title": "XSOAR testing",
"author": "00000000-0000-0000-0000-000000000001",
"lastAuthor": "00000000-0000-0000-0000-000000000002",
"assignee": "00000000-0000-0000-0000-000000000001",
"status": "PENDING",
"favorite": false,
"caseId": 1001
}
],
"closureDetails": {
"reason": "NOT_MALICIOUS",
"rootCause": "False positive from detection rule",
"caseClosedAction": "MANUALLY",
"comment": "Reviewed and confirmed benign activity.\n Case closed by Siemplify API. \nAll attached playbooks and playbook blocks have been terminated.\nAll Alerts were closed."
}
}
}
}

Human Readable Output#

Case Information#

Case IDDisplay NamePriorityStatusStageAssigneeAlert CountTypeEnvironmentSourceWorkflow StatusSLAAlerts SLATagsCreate TimeUpdate TimeIncidentImportantInvolved Suspicious EntityOverflow CaseLast Modifying User IDProductsTasksClosure Details
1001Test CaseMEDIUMOPENEDTriage@Tier115EXTERNALDefault EnvironmentServerPENDING_FOR_USERStatus: OPEN_SLA
Expiration Time: 2026-06-07 11:43:40 UTC
Critical Expiration Time: 2026-06-04 13:43:40 UTC
Status: OPEN_SLA
Expiration Time: 2026-06-29 23:00:00 UTC
- displayName: demo 1
priority: 0
- displayName: demo 2
priority: 1
2026-05-14 17:16:19 UTC2026-05-22 05:16:27 UTCFalseFalseFalseFalse00000000-0000-0000-0000-000000000002- displayName: Test Case
alert: alert 1
- displayName: Test Case
alert: alert 2
- id: 3
createTime: 1779447705049
updateTime: 1779447705049
content: Testing
title: XSOAR testing
author: 00000000-0000-0000-0000-000000000001
lastAuthor: 00000000-0000-0000-0000-000000000002
assignee: 00000000-0000-0000-0000-000000000001
status: PENDING
favorite: False
caseId: 1001
reason: NOT_MALICIOUS
rootCause: False positive from detection rule
caseClosedAction: MANUALLY
comment: Reviewed and confirmed benign activity.
Case closed by Siemplify API.
All attached playbooks and playbook blocks have been terminated.
All Alerts were closed.

gcb-case-update#


Update the properties of a case.

Base Command#

gcb-case-update

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required
display_nameSpecify the new title for the case.

Note: If the value is greater than 200 characters, it will be truncated to 200 characters.
Optional
descriptionSpecify the new description for the case.

Note: If the value is greater than 1000 characters, it will be truncated to 1000 characters.
Optional
importantSpecify whether to mark the case as important. Possible values are: True, False.Optional
incidentSpecify whether to mark the case as an incident. Possible values are: True, False.Optional

Context Output#

PathTypeDescription
GoogleSecOps.Case.nameStringThe unique resource name of the Case.
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.displayNameStringThe title of the Case.
GoogleSecOps.Case.creatorUserIdStringThe ID of the user who created the Case.
GoogleSecOps.Case.lastModifyingUserIdStringThe ID of the user who last modified the Case.
GoogleSecOps.Case.createTimeStringThe creation time of the Case (unix epoch milliseconds).
GoogleSecOps.Case.updateTimeStringThe last update time of the Case (unix epoch milliseconds).
GoogleSecOps.Case.alertCountNumberThe number of alerts linked to the Case.
GoogleSecOps.Case.stageStringThe current workflow stage of the Case.
GoogleSecOps.Case.priorityStringThe priority of the Case.
GoogleSecOps.Case.assigneeStringThe assigned user or SOC role of the Case.
GoogleSecOps.Case.descriptionStringThe description of the Case.
GoogleSecOps.Case.typeStringThe type of the Case.
GoogleSecOps.Case.environmentStringThe logical environment of the Case.
GoogleSecOps.Case.statusStringThe status of the Case.
GoogleSecOps.Case.scoreNumberThe attack exposure score of the Case.
GoogleSecOps.Case.workflowStatusStringThe playbook or workflow status of the Case.
GoogleSecOps.Case.sourceStringThe source that created the Case.
GoogleSecOps.Case.importantBooleanWhether the Case is marked as important.
GoogleSecOps.Case.incidentBooleanWhether the Case is marked as an incident.
GoogleSecOps.Case.overflowCaseBooleanWhether the Case is an overflow case due to large data volume.
GoogleSecOps.Case.involvedSuspiciousEntityBooleanWhether a suspicious entity is involved in the Case.
GoogleSecOps.Case.sla.expirationTimeStringThe SLA expiration time of the Case (unix ms).
GoogleSecOps.Case.sla.criticalExpirationTimeStringThe SLA critical expiration time of the Case (unix ms).
GoogleSecOps.Case.sla.expirationStatusStringThe SLA expiration status of the Case.
GoogleSecOps.Case.sla.remainingTimeSinceLastPauseNumberThe remaining time since the last SLA pause of the Case.
GoogleSecOps.Case.alertsSla.expirationTimeStringThe aggregated alerts SLA expiration time of the Case (unix ms).
GoogleSecOps.Case.alertsSla.criticalExpirationTimeStringThe aggregated alerts SLA critical expiration time of the Case (unix ms).
GoogleSecOps.Case.alertsSla.expirationStatusStringThe aggregated alerts SLA expiration status.
GoogleSecOps.Case.alertsSla.remainingTimeSinceLastPauseNumberThe remaining time since the last alerts SLA pause of the Case.
GoogleSecOps.Case.tags.displayNameStringThe display name of the tag.
GoogleSecOps.Case.tags.priorityNumberThe priority order of the tag.
GoogleSecOps.Case.products.displayNameStringThe display name of the product.
GoogleSecOps.Case.products.alertStringThe resource name of the alert associated with the product.
GoogleSecOps.Case.tasks.idStringThe ID of the task.
GoogleSecOps.Case.tasks.titleStringThe title of the task.
GoogleSecOps.Case.tasks.contentStringThe content/description of the task.
GoogleSecOps.Case.tasks.statusStringThe status of the task.
GoogleSecOps.Case.tasks.assigneeStringThe assignee of the task.
GoogleSecOps.Case.tasks.authorStringThe author who created the task.
GoogleSecOps.Case.tasks.lastAuthorStringThe last user who modified the task.
GoogleSecOps.Case.tasks.createTimeStringThe creation time of the task (unix epoch milliseconds).
GoogleSecOps.Case.tasks.updateTimeStringThe last update time of the task (unix epoch milliseconds).
GoogleSecOps.Case.tasks.caseIdNumberThe ID of the Case the task belongs to.
GoogleSecOps.Case.tasks.favoriteBooleanWhether the task is marked as a favorite.
GoogleSecOps.Case.closureDetails.reasonStringThe closure reason of the Case.
GoogleSecOps.Case.closureDetails.commentStringThe closure comment of the Case.
GoogleSecOps.Case.closureDetails.rootCauseStringThe root cause provided at closure.
GoogleSecOps.Case.closureDetails.caseClosedActionStringThe action taken when the Case was closed.

Command example#

!gcb-case-update case_id=1001 display_name="XSOAR 1 Testing" important=True

Context Example#

{
"GoogleSecOps": {
"Case": {
"caseId": "1001",
"lastModifyingUserId": "Siemplify automation",
"createTime": "1780569465745",
"updateTime": "1780912611281",
"displayName": "XSOAR 1 Testing",
"alertCount": 1,
"stage": "Triage",
"priority": "PRIORITY_LOW",
"important": true,
"incident": false,
"assignee": "00000000-0000-0000-0000-000000000001",
"type": "EXTERNAL",
"overflowCase": false,
"environment": "XSOAR",
"status": "OPENED",
"workflowStatus": "NONE",
"sla": {
"expirationStatus": "NO_SLA"
},
"alertsSla": {
"expirationStatus": "NO_SLA"
},
"source": "User",
"involvedSuspiciousEntity": false
}
}
}

Human Readable Output#

Updated Case Information#

Case IDDisplay NamePriorityStatusStageAssigneeAlert CountTypeEnvironmentSourceWorkflow StatusSLAAlerts SLACreate TimeUpdate TimeIncidentImportantInvolved Suspicious EntityOverflow CaseLast Modifying User ID
1001XSOAR 1 TestingLOWOPENEDTriage00000000-0000-0000-0000-0000000000011EXTERNALXSOARUserNONEStatus: NO_SLAStatus: NO_SLA2026-06-04 10:37:45 UTC2026-06-08 09:56:51 UTCFalseTrueFalseFalseSiemplify automation

gcb-case-tag-add#


Add the specified tags to the cases.

Base Command#

gcb-case-tag-add

Input#

Argument NameDescriptionRequired
case_idsSpecify the IDs of the case to add tags. Supports comma-separated values.

Note: Use gcb-case-list to retrieve case ID.
Required
tagsSpecify the tags to add to the cases. Supports comma-separated values.Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.recentlyAddedTagsStringThe list of recently added tags.

Command example#

!gcb-case-tag-add case_ids=1001,1002 tags=malware,phishing

Context Example#

{
"GoogleSecOps": {
"Case": [
{
"caseId": "1001",
"recentlyAddedTags": ["malware", "phishing"]
},
{
"caseId": "1002",
"recentlyAddedTags": ["malware", "phishing"]
}
]
}
}

Human Readable Output#

Tags malware, phishing successfully added to cases 1001, 1002.

gcb-case-tag-remove#


Remove the specified tag from a case.

Base Command#

gcb-case-tag-remove

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case to remove the tag.

Note: Use gcb-case-list to retrieve case ID.
Required
tagSpecify the tag to remove from the case.Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.recentlyRemovedTagStringThe tag that was recently removed from the case.

Command example#

!gcb-case-tag-remove case_id=1001 tag=malware

Context Example#

{
"GoogleSecOps": {
"Case": {
"caseId": "1001",
"recentlyRemovedTag": "malware"
}
}
}

Human Readable Output#

Tag malware successfully removed from case 1001.

gcb-case-priority-change#


Change the priority of the specified cases.

Base Command#

gcb-case-priority-change

Input#

Argument NameDescriptionRequired
case_idsSpecify the IDs of the case to change priority. Supports comma-separated values.

Note: Use gcb-case-list to retrieve case ID.
Required
prioritySpecify the new priority level for the cases. Possible values are: UNSPECIFIED, INFO, LOW, MEDIUM, HIGH, CRITICAL.Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.priorityStringThe updated priority of the Case.

Command example#

!gcb-case-priority-change case_ids=1001,1002 priority=CRITICAL

Context Example#

{
"GoogleSecOps": {
"Case": [
{
"caseId": "1001",
"priority": "CRITICAL"
},
{
"caseId": "1002",
"priority": "CRITICAL"
}
]
}
}

Human Readable Output#

Priority of cases 1001, 1002 successfully changed to CRITICAL.

gcb-case-stage-definition-list#


Retrieve the list of case stage definitions configured in the instance.

Base Command#

gcb-case-stage-definition-list

Input#

There are no input arguments for this command.

Context Output#

PathTypeDescription
GoogleSecOps.CaseStageDefinitionUnknownThe list of the case stage definitions.

Command example#

!gcb-case-stage-definition-list

Context Example#

{
"GoogleSecOps": {
"CaseStageDefinition": [
"Triage",
"Assessment",
"Investigation"
]
}
}

Human Readable Output#

Case Stage Definitions: Triage, Assessment, Investigation

gcb-case-stage-change#


Change the workflow stage of the specified cases.

Base Command#

gcb-case-stage-change

Input#

Argument NameDescriptionRequired
case_idsSpecify the IDs of the case to change stage. Supports comma-separated values.

Note: Use gcb-case-list to retrieve case ID.
Required
stageSpecify the new workflow stage name.

Note: Use gcb-case-stage-definition-list to retrieve case stage definition list. Possible values are: Triage, Incident, Investigation.
Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.stageStringThe updated workflow stage of the Case.

Command example#

!gcb-case-stage-change case_ids=1001,1002 stage=Investigation

Context Example#

{
"GoogleSecOps": {
"Case": [
{
"caseId": "1001",
"stage": "Investigation"
},
{
"caseId": "1002",
"stage": "Investigation"
}
]
}
}

Human Readable Output#

Stage of cases 1001, 1002 successfully changed to Investigation.

gcb-case-reopen#


Reopen the specified cases.

Base Command#

gcb-case-reopen

Input#

Argument NameDescriptionRequired
case_idsSpecify the IDs of the case to reopen. Supports comma-separated values.

Note: Use gcb-case-list to retrieve case ID.
Required
reopen_commentSpecify a comment explaining why the cases are being reopened.Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.statusStringThe status of the Case after reopening.

Command example#

!gcb-case-reopen case_ids=1001,1002 reopen_comment="Reopening due to new evidence of malicious activity."

Context Example#

{
"GoogleSecOps": {
"Case": [
{
"caseId": "1001",
"status": "OPENED"
},
{
"caseId": "1002",
"status": "OPENED"
}
]
}
}

Human Readable Output#

Cases 1001, 1002 successfully reopened.

gcb-case-close-definition-list#


Retrieve the list of case close definitions configured in the instance.

Base Command#

gcb-case-close-definition-list

Input#

There are no input arguments for this command.

Context Output#

PathTypeDescription
GoogleSecOps.CaseCloseDefinition.nameStringThe unique resource name of the Case close definition.
GoogleSecOps.CaseCloseDefinition.closeReasonStringThe close reason of the Case close definition.
GoogleSecOps.CaseCloseDefinition.rootCauseStringThe root cause of the Case close definition.

Command example#

!gcb-case-close-definition-list

Context Example#

{
"GoogleSecOps": {
"CaseCloseDefinition": [
{
"name": "projects/my-project/locations/us/instances/my-instance/caseCloseDefinitions/1",
"closeReason": "MAINTENANCE",
"rootCause": "Rule under construction"
},
{
"name": "projects/my-project/locations/us/instances/my-instance/caseCloseDefinitions/2",
"closeReason": "INCONCLUSIVE",
"rootCause": "No clear conclusion"
},
{
"name": "projects/my-project/locations/us/instances/my-instance/caseCloseDefinitions/3",
"closeReason": "NOT_MALICIOUS",
"rootCause": "Similar case is already under investigation"
},
{
"name": "projects/my-project/locations/us/instances/my-instance/caseCloseDefinitions/4",
"closeReason": "MALICIOUS",
"rootCause": "Irrelevant TCP/UDP port"
}
]
}
}

Human Readable Output#

Close ReasonRoot Cause
MAINTENANCERule under construction
INCONCLUSIVENo clear conclusion
NOT_MALICIOUSSimilar case is already under investigation
MALICIOUSIrrelevant TCP/UDP port

gcb-case-close#


Close the specified cases.

Base Command#

gcb-case-close

Input#

Argument NameDescriptionRequired
case_idsSpecify the IDs of the case to close. Supports comma-separated values.

Note: Use gcb-case-list to retrieve case ID.
Required
close_reasonSpecify the reason for closing the cases. Possible values are: MALICIOUS, NOT_MALICIOUS, MAINTENANCE, INCONCLUSIVE, UNKNOWN, CLOSE_REASON_UNSPECIFIED.Required
root_causeSpecify the root cause description for the closure.Required
close_commentSpecify a comment to add when closing the cases.Optional

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.statusStringThe status of the Case after closure.
GoogleSecOps.Case.closureDetails.reasonStringThe closure reason of the Case.
GoogleSecOps.Case.closureDetails.commentStringThe closure comment of the Case.
GoogleSecOps.Case.closureDetails.rootCauseStringThe root cause provided at closure.

Command example#

!gcb-case-close case_ids=1001,1002 close_reason=NOT_MALICIOUS root_cause="False positive from detection rule" close_comment="Confirmed not malicious"

Context Example#

{
"GoogleSecOps": {
"Case": [
{
"caseId": "1001",
"status": "CLOSED",
"closureDetails": {
"reason": "NOT_MALICIOUS",
"rootCause": "False positive",
"comment": "Confirmed not malicious"
}
},
{
"caseId": "1002",
"status": "CLOSED",
"closureDetails": {
"reason": "NOT_MALICIOUS",
"rootCause": "False positive",
"comment": "Confirmed not malicious"
}
}
]
}
}

Human Readable Output#

Cases 1001, 1002 successfully closed with reason NOT_MALICIOUS.

gcb-case-assign#


Assign the specified cases to a specific analyst or SOC role.

Base Command#

gcb-case-assign

Input#

Argument NameDescriptionRequired
case_idsSpecify the IDs of the case to assign. Supports comma-separated values.

Note: Use gcb-case-list to retrieve case ID.
Required
assigneeSpecify the user email address or a SOC role.

For SOC roles, add the @ prefix (for example, @Tier1).
Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.assigneeStringThe resolved user ID or SOC role assigned to the Case after the operation.

Command example#

!gcb-case-assign case_ids=1001,1002 assignee=@SocRole

Context Example#

{
"GoogleSecOps": {
"Case": [
{
"caseId": "1001",
"assignee": "@SocRole"
},
{
"caseId": "1002",
"assignee": "@SocRole"
}
]
}
}

Human Readable Output#

Cases 1001, 1002 successfully assigned to @SocRole.

gcb-case-comment-list#


Retrieve the list of comments associated with the specified case.

Base Command#

gcb-case-comment-list

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case to retrieve comments.

Note: Use gcb-case-list to retrieve case ID.
Required
page_sizeSpecify the maximum number of comments to return.

Note: Maximum value is 1000. Default is 50.
Optional
page_tokenSpecify the page token for pagination.

Note: Use the next_page_token from a previous gcb-case-comment-list response.
Optional
sort_bySpecify the field to sort results by. Possible values are: createTime, updateTime, user, comment, deletionInvoker, favorite, alert, deleted. Default is createTime.Optional
sort_orderSpecify the sort direction for the results. Possible values are: Asc, Desc. Default is Desc.Optional

Context Output#

PathTypeDescription
GoogleSecOps.CaseComment.nameStringThe unique resource name of the Case comment.
GoogleSecOps.CaseComment.commentIdStringThe ID of the Case comment.
GoogleSecOps.CaseComment.createTimeStringThe creation time of the Case comment (unix epoch milliseconds).
GoogleSecOps.CaseComment.updateTimeStringThe last update time of the Case comment (unix epoch milliseconds).
GoogleSecOps.CaseComment.userStringUser owner of the comment.
GoogleSecOps.CaseComment.commentStringThe text of the Case comment.
GoogleSecOps.CaseComment.userOwnerFullNameStringThe user who created the comment.
GoogleSecOps.CaseComment.lastEditorFullNameStringThe user who last edited the comment.
GoogleSecOps.CaseComment.deletedByUserStringThe user who deleted the comment.
GoogleSecOps.CaseComment.alertIdentifierStringThe alert associated with the comment.
GoogleSecOps.CaseComment.isFavoriteBooleanWhether the comment is marked as a favorite.
GoogleSecOps.CaseComment.isDeletedBooleanIndicates if the comment has been softly deleted.
GoogleSecOps.CaseComment.caseStringThe case associated with the comment.
GoogleSecOps.PageToken.commandStringThe command name associated with the pagination token.
GoogleSecOps.PageToken.nextPageTokenStringToken to fetch the next page of case comments.
GoogleSecOps.PageToken.totalSizeNumberThe total number of case comments available.

Command example#

!gcb-case-comment-list case_id=1001

Context Example#

{
"GoogleSecOps": {
"CaseComment": [
{
"name": "projects/chronicle-mock-proj/locations/us/instances/mock-inst-uuid/cases/1001/caseComments/2001",
"commentId": "2001",
"createTime": "1780466772061",
"updateTime": "1780466772061",
"comment": "Initial assessment complete. Escalating to senior analyst.",
"isFavorite": true,
"alertIdentifier": "alert-mock-security-001",
"isDeleted": false,
"case": "1001"
},
{
"name": "projects/chronicle-mock-proj/locations/us/instances/mock-inst-uuid/cases/1001/caseComments/2002",
"commentId": "2002",
"createTime": "1780465892736",
"updateTime": "1780465892736",
"user": "user-uuid-mock-12345",
"comment": "Threat actor identified. Initiating containment measures.",
"userOwnerFullName": "Bob Wilson",
"lastEditorFullName": "Bob Wilson",
"isFavorite": false,
"isDeleted": false,
"deletedByUser": "user-uuid-mock-12345",
"case": "1001"
}
],
"PageToken": {
"command": "gcb-case-comment-list",
"nextPageToken": "mock-pagination-token",
"totalSize": 4
}
}
}

Human Readable Output#

Case Comments#

AuthorCommentCreate Time
AutomationInitial assessment complete. Escalating to senior analyst.2026-06-03 06:06:12 UTC
Bob WilsonThreat actor identified. Initiating containment measures.2026-06-03 05:51:32 UTC

Maximum number of comments specified in page_size has been returned. To fetch the next set of comments, execute the command with the page token as mock-pagination-token.

gcb-case-comment-create#


Add a comment to the specified case.

Base Command#

gcb-case-comment-create

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case to add the comment.

Note: Use gcb-case-list to retrieve case ID.
Required
commentSpecify the comment text to add to the case.Required

Context Output#

PathTypeDescription
GoogleSecOps.CaseComment.nameStringThe unique resource name of the Case comment.
GoogleSecOps.CaseComment.commentIdStringThe ID of the Case comment.
GoogleSecOps.CaseComment.createTimeStringThe creation time of the Case comment (unix epoch milliseconds).
GoogleSecOps.CaseComment.updateTimeStringThe last update time of the Case comment (unix epoch milliseconds).
GoogleSecOps.CaseComment.userStringUser owner of the comment.
GoogleSecOps.CaseComment.commentStringThe text of the Case comment.
GoogleSecOps.CaseComment.userOwnerFullNameStringThe user who created the comment.
GoogleSecOps.CaseComment.lastEditorFullNameStringThe user who last edited the comment.
GoogleSecOps.CaseComment.deletedByUserStringThe user who deleted the comment.
GoogleSecOps.CaseComment.alertIdentifierStringThe alert associated with the comment.
GoogleSecOps.CaseComment.isFavoriteBooleanWhether the comment is marked as a favorite.
GoogleSecOps.CaseComment.isDeletedBooleanIndicates if the comment has been softly deleted.
GoogleSecOps.CaseComment.caseStringThe case associated with the comment.

Command example#

!gcb-case-comment-create case_id=1001 comment="Investigated the outbound traffic. Confirmed malicious C2 communication."

Context Example#

{
"GoogleSecOps": {
"CaseComment": {
"name": "projects/chronicle-mock-proj/locations/us/instances/mock-inst-uuid/cases/1001/caseComments/comment-001",
"commentId": "comment-001",
"createTime": "1780642722226",
"updateTime": "1780642722226",
"comment": "Investigated the outbound traffic. Confirmed malicious C2 communication.",
"isFavorite": false,
"isDeleted": false,
"case": "1001"
}
}
}

Human Readable Output#

Successfully added the following comment to case "1001" at 2026-06-05 06:58:42 UTC:

Investigated the outbound traffic. Confirmed malicious C2 communication.

gcb-case-sla-pause#


Pause the SLA timer for the specified case.

Base Command#

gcb-case-sla-pause

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case to pause the SLA timer.

Note: Use gcb-case-list to retrieve case ID.
Required
messageSpecify the reason for pausing the SLA timer.Optional

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.slaStatusStringThe SLA status of the Case after the operation.

Command example#

!gcb-case-sla-pause case_id=1001 message="Pausing SLA pending additional investigation."

Context Example#

{
"GoogleSecOps": {
"Case": {
"caseId": "1001",
"slaStatus": "PAUSED"
}
}
}

Human Readable Output#

SLA timer for case 1001 successfully paused.

gcb-case-sla-resume#


Resume the SLA timer for the specified case.

Base Command#

gcb-case-sla-resume

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case to resume the SLA timer.

Note: Use gcb-case-list to retrieve case ID.
Required

Context Output#

PathTypeDescription
GoogleSecOps.Case.caseIdStringThe ID of the Case.
GoogleSecOps.Case.slaStatusStringThe SLA status of the Case after the operation.

Command example#

!gcb-case-sla-resume case_id=1001

Context Example#

{
"GoogleSecOps": {
"Case": {
"caseId": "1001",
"slaStatus": "SLA_EXPIRATION_STATUS_UNSPECIFIED"
}
}
}

Human Readable Output#

SLA timer for case 1001 successfully resumed.

gcb-case-alert-list#


Retrieve the list of alerts associated with the specified case.

Base Command#

gcb-case-alert-list

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case to list alerts.

Note: Use gcb-case-list to retrieve case ID.
Required
display_nameFilter alerts by display name. Supports comma-separated values.Optional
priorityFilter alerts by priority. Supports comma-separated values. Possible values are: LEGACY_CASE_PRIORITY_UNSPECIFIED, UNCHANGED, INFORMATIVE, LOW, MEDIUM, HIGH, CRITICAL.Optional
statusFilter alerts by status. Supports comma-separated values. Possible values are: OPEN, CLOSE, ALERT_STATUS_UNSPECIFIED.Optional
productFilter alerts by product name. Supports comma-separated values.Optional
vendorFilter alerts by vendor name. Supports comma-separated values.Optional
tagFilter alerts by tag name. Supports comma-separated values.Optional
environmentFilter alerts by environment name. Supports comma-separated values.Optional
source_system_nameFilter alerts by the alerting system that raised the alert. Supports comma-separated values.Optional
manualFilter alerts by whether they were created manually. Possible values are: True, False.Optional
create_start_timeFilter alerts created on or after this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
create_end_timeFilter alerts created on or before this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
update_start_timeFilter alerts updated on or after this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
update_end_timeFilter alerts updated on or before this time.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.

For example: 01 May 2026, 2026-05-17T14:05:44Z.
Optional
advanced_filterSpecify a raw AIP-160 filter string to query alerts with advanced conditions. When provided, this filter is used as-is and all other filter arguments are ignored.

Note: Supported filter fields: displayName, product, vendor, environment, sourceSystemName, priority, status, createTime, updateTime.

Example: (priority='HIGH' OR status='OPEN') AND product='DLP'.
Optional
filter_logicSpecify the logical operator to combine filter conditions. Possible values are: AND, OR. Default is AND.Optional
page_sizeSpecify the maximum number of alerts to return.

Note: Maximum value is 1000. Default is 50.
Optional
page_tokenSpecify the page token for pagination.

Note: Use the next_page_token from a previous gcb-case-alert-list response.
Optional
sort_bySpecify the field to sort results by. Possible values are: displayName, caseId, identifier, sourceGroupingIdentifier, product, vendor, environment, ticketId, sourceSystemName, priority, status, startTime, endTime, createTime. Default is createTime.Optional
sort_orderSpecify the sort direction for the results. Possible values are: Asc, Desc. Default is Desc.Optional

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.nameStringThe unique resource name of the Case Alert.
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert extracted from the resource name.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.identifierStringThe legacy identifier (alert title + GUID) of the Case Alert.
GoogleSecOps.CaseAlert.sourceGroupingIdentifierStringThe source grouping identifier used to group related Case Alerts.
GoogleSecOps.CaseAlert.alertGroupIdentifierStringThe alert group identifier of the Case Alert.
GoogleSecOps.CaseAlert.displayNameStringThe display name of the Case Alert.
GoogleSecOps.CaseAlert.productStringThe product associated with the Case Alert.
GoogleSecOps.CaseAlert.vendorStringThe vendor associated with the Case Alert.
GoogleSecOps.CaseAlert.environmentStringThe environment of the Case Alert.
GoogleSecOps.CaseAlert.sourceSystemNameStringThe alerting system that raised the Case Alert.
GoogleSecOps.CaseAlert.sourceIdentifierStringThe source identifier (e.g. connector ID) of the Case Alert.
GoogleSecOps.CaseAlert.ruleGeneratorStringThe third-party rule that triggered the Case Alert.
GoogleSecOps.CaseAlert.siemAlertIdStringThe SIEM alert identifier of the Case Alert.
GoogleSecOps.CaseAlert.sourceUrlStringThe source URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceRuleUrlStringThe source rule URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceSystemUrlStringThe source system URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceRuleIdentifierStringThe source rule identifier of the Case Alert.
GoogleSecOps.CaseAlert.ticketIdStringThe ticket ID linked to the Case Alert in the integrated ticketing system.
GoogleSecOps.CaseAlert.additionalPropertiesStringThe additional connector data of the Case Alert as a JSON string.
GoogleSecOps.CaseAlert.priorityStringThe priority of the Case Alert.
GoogleSecOps.CaseAlert.statusStringThe status of the Case Alert.
GoogleSecOps.CaseAlert.manualBooleanWhether the Case Alert was created manually.
GoogleSecOps.CaseAlert.nestingDepthNumberThe nesting depth level of the Case Alert.
GoogleSecOps.CaseAlert.playbookStatusStringThe playbook or workflow status of the Case Alert.
GoogleSecOps.CaseAlert.attachedPlaybookNameStringThe name of the playbook attached to the Case Alert.
GoogleSecOps.CaseAlert.eventCountNumberThe number of events that triggered the Case Alert.
GoogleSecOps.CaseAlert.playbookRunCountNumberThe number of times the first playbook was run for the Case Alert.
GoogleSecOps.CaseAlert.createTimeStringThe creation time of the Case Alert (unix epoch milliseconds).
GoogleSecOps.CaseAlert.updateTimeStringThe last update time of the Case Alert (unix epoch milliseconds).
GoogleSecOps.CaseAlert.startTimeStringThe time the alert was created on the third-party system.
GoogleSecOps.CaseAlert.endTimeStringThe time the alert was closed on the third-party system.
GoogleSecOps.CaseAlert.sla.expirationStatusStringThe SLA expiration status of the Case Alert.
GoogleSecOps.CaseAlert.sla.expirationTimeStringThe SLA expiration time of the Case Alert.
GoogleSecOps.CaseAlert.sla.criticalExpirationTimeStringThe SLA critical expiration time of the Case Alert.
GoogleSecOps.CaseAlert.sla.remainingTimeSinceLastPauseNumberThe remaining time since the last SLA pause of the Case Alert.
GoogleSecOps.CaseAlert.tags.tagStringThe tag value associated with the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.reasonStringThe closure reason of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.commentStringThe closure comment of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.rootCauseStringThe root cause provided at closure of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.closingTimeMsStringThe closure time of the Case Alert in Unix milliseconds.
GoogleSecOps.CaseAlert.involvedRelations.identifierStringThe identifier of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.alertIdentifierStringThe identifier of the alert the Involved Relation belongs to.
GoogleSecOps.CaseAlert.involvedRelations.caseIdNumberThe Case ID the Involved Relation belongs to.
GoogleSecOps.CaseAlert.involvedRelations.relationTypeStringThe type of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.deviceProductStringThe product associated with the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.deviceVendorStringThe vendor associated with the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.categoryOutcomeStringThe category outcome of the Involved Relation (e.g. Blocked, Allowed).
GoogleSecOps.CaseAlert.involvedRelations.destinationPortStringThe destination port of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.eventClassIdStringThe event display name of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.startTimeDateThe start time of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.endTimeDateThe end time of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.additionalPropertiesStringThe additional data of the Involved Relation as a JSON string.
GoogleSecOps.CaseAlert.involvedRelations.from.identifierStringThe identifier of the source entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.from.typeStringThe type of the source entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.to.identifierStringThe identifier of the destination entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.to.typeStringThe type of the destination entity of the Involved Relation.
GoogleSecOps.PageToken.commandStringThe command name associated with the pagination token.
GoogleSecOps.PageToken.nextPageTokenStringThe token to retrieve the next page of Case Alerts.
GoogleSecOps.PageToken.totalSizeNumberThe total number of Case Alerts matching the query.

Command example#

!gcb-case-alert-list case_id=1001 priority=HIGH status=OPEN sort_by=priority sort_order=Asc page_size=10

Context Example#

{
"GoogleSecOps": {
"CaseAlert": [
{
"name": "projects/chronicle-mock-proj/locations/us/instances/00000000-0000-0000-0000-000000000001/cases/1001/caseAlerts/1000001",
"alertId": "1000001",
"caseId": 1001,
"identifier": "TEST ALERT_00000000-0000-0000-0000-000000000010",
"displayName": "TEST ALERT",
"product": "Test Product",
"vendor": "Test Vendor",
"environment": "Default Environment",
"sourceSystemName": "Test Source System",
"ruleGenerator": "Test-Alert-Rule-01",
"sourceGroupingIdentifier": "0.0.0.1",
"sourceIdentifier": "Test Source Identifier_00000000-0000-0000-0000-000000000011",
"ticketId": "0.0.0.1_2026-05-10 08:00:00",
"additionalProperties": "{\"Name\":\"TEST ALERT\",\"Type\":\"ALERT\"}",
"priority": "HIGH",
"status": "OPEN",
"createTime": "1778778979232",
"updateTime": "1779426987796",
"startTime": "1778778979232",
"endTime": "1779426987796",
"playbookStatus": "COMPLETED",
"attachedPlaybookName": "Test Playbook",
"alertGroupIdentifier": "TEST ALERT_00000000-0000-0000-0000-000000000010",
"eventCount": 5,
"playbookRunCount": 1,
"sla": {
"expirationTime": "1780832620238",
"expirationStatus": "OPEN_SLA"
},
"tags": [
{
"tag": "demo_1"
}
],
"involvedRelations": [
{
"identifier": "00000000-0000-0000-0000-000000000020",
"alertIdentifier": "TEST ALERT_00000000-0000-0000-0000-000000000010",
"caseId": 1001,
"relationType": "ALERT",
"deviceProduct": "Test Product",
"deviceVendor": "Test Vendor",
"categoryOutcome": "Blocked",
"destinationPort": "443",
"eventClassId": "Test Event Class",
"from": {
"identifier": "0.0.0.1",
"type": "ADDRESS"
},
"to": {
"identifier": "test-host-01",
"type": "HOSTNAME"
}
}
]
},
{
"name": "projects/chronicle-mock-proj/locations/us/instances/00000000-0000-0000-0000-000000000001/cases/1001/caseAlerts/1000002",
"alertId": "1000002",
"caseId": 1001,
"identifier": "TEST ALERT 2_00000000-0000-0000-0000-000000000030",
"displayName": "TEST ALERT 2",
"product": "Test Product 2",
"vendor": "Test Vendor 2",
"environment": "Default Environment",
"sourceSystemName": "Test Source System 2",
"ruleGenerator": "Test-Alert-Rule-02",
"sourceGroupingIdentifier": "0.0.0.1",
"ticketId": "0.0.0.2_2026-05-10 07:00:00",
"additionalProperties": "{\"Name\":\"TEST ALERT 2\",\"Type\":\"ALERT\"}",
"priority": "MEDIUM",
"status": "OPEN",
"createTime": "1778778979000",
"updateTime": "1779426987000",
"startTime": "1778778979000",
"endTime": "1779426987000",
"playbookStatus": "PENDING_FOR_USER",
"attachedPlaybookName": "Test Playbook 2",
"alertGroupIdentifier": "TEST ALERT 2_00000000-0000-0000-0000-000000000030",
"eventCount": 2,
"playbookRunCount": 0,
"sla": {
"expirationTime": "1779426987000",
"expirationStatus": "OPEN_SLA"
}
}
],
"PageToken": {
"command": "gcb-case-alert-list",
"nextPageToken": "test-next-page-token",
"totalSize": 10
}
}
}

Human Readable Output#

Case Alerts List#

Alert IDAlert NameCreate TimePriorityStatusEvents CountAlert SLAPlaybook Attached NamePlaybook Attached Status
1000001TEST ALERT2026-05-14 17:16:19 UTCHIGHOPEN5Status: OPEN_SLA
Expiration Time: 2026-06-07 11:43:40 UTC
Test PlaybookCOMPLETED
1000002TEST ALERT 22026-05-14 17:16:19 UTCMEDIUMOPEN2Status: OPEN_SLA
Expiration Time: 2026-05-22 05:16:27 UTC
Test Playbook 2PENDING_FOR_USER

Maximum number of alerts specified in page_size has been returned. To fetch the next set of alerts, execute the command with the page token as test-next-page-token.

gcb-case-alert-get#


Retrieve detailed information about a specific case alert by its ID.

Base Command#

gcb-case-alert-get

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to retrieve.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.nameStringThe unique resource name of the Case Alert.
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert extracted from the resource name.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.identifierStringThe legacy identifier (alert title + GUID) of the Case Alert.
GoogleSecOps.CaseAlert.sourceGroupingIdentifierStringThe source grouping identifier used to group related Case Alerts.
GoogleSecOps.CaseAlert.alertGroupIdentifierStringThe alert group identifier of the Case Alert.
GoogleSecOps.CaseAlert.displayNameStringThe display name of the Case Alert.
GoogleSecOps.CaseAlert.productStringThe product associated with the Case Alert.
GoogleSecOps.CaseAlert.vendorStringThe vendor associated with the Case Alert.
GoogleSecOps.CaseAlert.environmentStringThe environment of the Case Alert.
GoogleSecOps.CaseAlert.sourceSystemNameStringThe alerting system that raised the Case Alert.
GoogleSecOps.CaseAlert.sourceIdentifierStringThe source identifier (e.g. connector ID) of the Case Alert.
GoogleSecOps.CaseAlert.ruleGeneratorStringThe third-party rule that triggered the Case Alert.
GoogleSecOps.CaseAlert.siemAlertIdStringThe SIEM alert identifier of the Case Alert.
GoogleSecOps.CaseAlert.sourceUrlStringThe source URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceRuleUrlStringThe source rule URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceSystemUrlStringThe source system URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceRuleIdentifierStringThe source rule identifier of the Case Alert.
GoogleSecOps.CaseAlert.ticketIdStringThe ticket ID linked to the Case Alert in the integrated ticketing system.
GoogleSecOps.CaseAlert.additionalPropertiesStringThe additional connector data of the Case Alert as a JSON string.
GoogleSecOps.CaseAlert.priorityStringThe priority of the Case Alert.
GoogleSecOps.CaseAlert.statusStringThe status of the Case Alert.
GoogleSecOps.CaseAlert.manualBooleanWhether the Case Alert was created manually.
GoogleSecOps.CaseAlert.nestingDepthNumberThe nesting depth level of the Case Alert.
GoogleSecOps.CaseAlert.playbookStatusStringThe playbook or workflow status of the Case Alert.
GoogleSecOps.CaseAlert.attachedPlaybookNameStringThe name of the playbook attached to the Case Alert.
GoogleSecOps.CaseAlert.eventCountNumberThe number of events that triggered the Case Alert.
GoogleSecOps.CaseAlert.playbookRunCountNumberThe number of times the first playbook was run for the Case Alert.
GoogleSecOps.CaseAlert.createTimeStringThe creation time of the Case Alert (unix epoch milliseconds).
GoogleSecOps.CaseAlert.updateTimeStringThe last update time of the Case Alert (unix epoch milliseconds).
GoogleSecOps.CaseAlert.startTimeStringThe time the alert was created on the third-party system.
GoogleSecOps.CaseAlert.endTimeStringThe time the alert was closed on the third-party system.
GoogleSecOps.CaseAlert.sla.slaStatusStringThe SLA expiration status of the Case Alert.
GoogleSecOps.CaseAlert.sla.slaExpireTimeStringThe SLA expiration time of the Case Alert.
GoogleSecOps.CaseAlert.tags.tagStringThe tag value associated with the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.reasonStringThe closure reason of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.commentStringThe closure comment of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.rootCauseStringThe root cause provided at closure of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.closingTimeMsStringThe closure time of the Case Alert in Unix milliseconds.
GoogleSecOps.CaseAlert.involvedRelations.identifierStringThe identifier of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.alertIdentifierStringThe identifier of the alert the Involved Relation belongs to.
GoogleSecOps.CaseAlert.involvedRelations.caseIdNumberThe Case ID the Involved Relation belongs to.
GoogleSecOps.CaseAlert.involvedRelations.relationTypeStringThe type of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.deviceProductStringThe product associated with the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.deviceVendorStringThe vendor associated with the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.categoryOutcomeStringThe category outcome of the Involved Relation (e.g. Blocked, Allowed).
GoogleSecOps.CaseAlert.involvedRelations.destinationPortStringThe destination port of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.eventClassIdStringThe event display name of the Involved Relation (e.g. Email Check, Data Exfiltration).
GoogleSecOps.CaseAlert.involvedRelations.startTimeStringThe start time of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.endTimeStringThe end time of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.additionalPropertiesStringThe additional data of the Involved Relation as a JSON string.
GoogleSecOps.CaseAlert.involvedRelations.from.identifierStringThe identifier of the source entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.from.typeStringThe type of the source entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.to.identifierStringThe identifier of the destination entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.to.typeStringThe type of the destination entity of the Involved Relation.

Command Example#

!gcb-case-alert-get case_id=1001 alert_id=1000001

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"name": "projects/chronicle-mock-proj/locations/us/instances/00000000-0000-0000-0000-000000000001/cases/1001/caseAlerts/1000001",
"alertId": "1000001",
"identifier": "TEST ALERT_00000000-0000-0000-0000-000000000010",
"caseId": 1001,
"createTime": "1778778979232",
"updateTime": "1779426987796",
"ruleGenerator": "Test-Alert-Rule-01",
"sourceGroupingIdentifier": "0.0.0.1",
"product": "Test Product",
"displayName": "TEST ALERT",
"vendor": "Test Vendor",
"environment": "Default Environment",
"ticketId": "0.0.0.1_2026-05-10 08:00:00",
"sourceSystemName": "Test Source System",
"closureDetails": {
"reason": "NOT_MALICIOUS",
"comment": "Testing",
"rootCause": "False positive from detection rule",
"closingTimeMs": "1779447705049"
},
"sla": {
"expirationTime": "1780832620238",
"expirationStatus": "OPEN_SLA"
},
"priority": "HIGH",
"sourceIdentifier": "Test Source Identifier_00000000-0000-0000-0000-000000000011",
"additionalProperties": "{\"Name\":\"TEST ALERT\",\"Type\":\"ALERT\",\"EndTime\":\"1779426987796\",\"Alert_Id\":\"0.0.0.1_2026-05-10 08:00:00\",\"TicketId\":\"0.0.0.1_2026-05-10 08:00:00\",\"DisplayId\":\"0.0.0.1_2026-05-10 08:00:00\",\"StartTime\":\"1778778979232\",\"IsArtifact\":\"False\",\"IsEnriched\":\"False\",\"IsTestCase\":\"False\",\"Description\":\"Test alert description.\",\"Environment\":\"Default Environment\",\"IsSuspicious\":\"False\",\"IsVulnerable\":\"False\",\"DataAccessScope\":null,\"IsInternalAsset\":\"False\",\"IsSkipPlaybooks\":null,\"AlertBaseEventIds\":\"00000000-0000-0000-0000-000000000012\",\"EstimatedStartTime\":\"1778778979232\"}",
"status": "OPEN",
"startTime": "1778778979232",
"endTime": "1779426987796",
"playbookStatus": "COMPLETED",
"attachedPlaybookName": "Test Playbook",
"alertGroupIdentifier": "TEST ALERT_00000000-0000-0000-0000-000000000010",
"eventCount": 5,
"playbookRunCount": 1,
"tags": [
{
"tag": "demo_1"
},
{
"tag": "demo_2"
}
],
"involvedRelations": [
{
"identifier": "00000000-0000-0000-0000-000000000020",
"alertIdentifier": "TEST ALERT_00000000-0000-0000-0000-000000000010",
"caseId": 1001,
"relationType": "ALERT",
"from": {
"identifier": "0.0.0.1",
"type": "ADDRESS"
},
"to": {
"identifier": "test-host-01",
"type": "HOSTNAME"
},
"deviceProduct": "Test Product",
"deviceVendor": "Test Vendor",
"categoryOutcome": "Blocked",
"destinationPort": "443",
"eventClassId": "Test Event Class"
}
]
}
}
}

Human Readable Output#

Case Alert Information#

Alert IDCase IDDisplay NameStatusPriorityProductVendorEnvironmentTagsSLAEvent CountAlert IdentifierAlert Group IdentifierPlaybook StatusAttached Playbook NamePlaybook Run CountCreate TimeUpdate TimeStart TimeEnd TimeManualRule GeneratorTicket IDSource System NameSource IdentifierSource Grouping IdentifierSiem Alert IDSource URLAdditional PropertiesClosure DetailsInvolved Relations
10000011001TEST ALERTOPENHIGHTest ProductTest VendorDefault Environmentdemo_1, demo_2Status: OPEN_SLA
Expiration Time: 2026-06-07 11:43:40 UTC
5TEST ALERT_00000000-0000-0000-0000-000000000010TEST ALERT_00000000-0000-0000-0000-000000000010COMPLETEDTest Playbook12026-05-14 17:16:19 UTC2026-05-22 05:16:27 UTC2026-05-14 17:16:19 UTC2026-05-22 05:16:27 UTCFalseTest-Alert-Rule-010.0.0.1_2026-05-10 08:00:00Test Source SystemTest Source Identifier_00000000-0000-0000-0000-0000000000110.0.0.10.0.0.1_2026-05-10 08:00:00http://demo.com/alerts/1000001{"Name":"TEST ALERT","Type":"ALERT","EndTime":"1779426987796","Alert_Id":"0.0.0.1_2026-05-10 08:00:00","TicketId":"0.0.0.1_2026-05-10 08:00:00","DisplayId":"0.0.0.1_2026-05-10 08:00:00","StartTime":"1778778979232","IsArtifact":"False","IsEnriched":"False","IsTestCase":"False","Description":"Test alert description.","Environment":"Default Environment","IsSuspicious":"False","IsVulnerable":"False","DataAccessScope":null,"IsInternalAsset":"False","IsSkipPlaybooks":null,"AlertBaseEventIds":"00000000-0000-0000-0000-000000000012","EstimatedStartTime":"1778778979232"}reason: NOT_MALICIOUS
comment: Testing
rootCause: False positive from detection rule
closingTimeMs: 1779447705049
- identifier: 00000000-0000-0000-0000-000000000020
alertIdentifier: TEST ALERT_00000000-0000-0000-0000-000000000010
caseId: 1001
relationType: ALERT
from:
identifier: 0.0.0.1
type: ADDRESS
to:
identifier: test-host-01
type: HOSTNAME
deviceProduct: Test Product
deviceVendor: Test Vendor
categoryOutcome: Blocked
destinationPort: 443
eventClassId: Test Event Class

gcb-case-alert-update#


Update the properties of an existing case alert.

Base Command#

gcb-case-alert-update

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to update.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
statusSpecify the new status for the alert. Possible values are: ALERT_STATUS_UNSPECIFIED, OPEN, CLOSE.Optional
prioritySpecify the new priority for the alert. Possible values are: LEGACY_CASE_PRIORITY_UNSPECIFIED, UNCHANGED, INFORMATIVE, LOW, MEDIUM, HIGH, CRITICAL.Optional
close_reasonSpecify the reason for closing the alert.

Note: Required when status is CLOSE. Possible values are: MALICIOUS, NOT_MALICIOUS, MAINTENANCE, INCONCLUSIVE, UNKNOWN, CLOSE_REASON_UNSPECIFIED.
Optional
close_commentSpecify a comment to add when closing the alert.Optional
root_causeSpecify the root cause for the alert closure.

Note: Required when status is CLOSE.
Optional

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.nameStringThe unique resource name of the Case Alert.
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert extracted from the resource name.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.identifierStringThe legacy identifier (alert title + GUID) of the Case Alert.
GoogleSecOps.CaseAlert.sourceGroupingIdentifierStringThe source grouping identifier used to group related Case Alerts.
GoogleSecOps.CaseAlert.alertGroupIdentifierStringThe alert group identifier of the Case Alert.
GoogleSecOps.CaseAlert.displayNameStringThe display name of the Case Alert.
GoogleSecOps.CaseAlert.productStringThe product associated with the Case Alert.
GoogleSecOps.CaseAlert.vendorStringThe vendor associated with the Case Alert.
GoogleSecOps.CaseAlert.environmentStringThe environment of the Case Alert.
GoogleSecOps.CaseAlert.sourceSystemNameStringThe alerting system that raised the Case Alert.
GoogleSecOps.CaseAlert.sourceIdentifierStringThe source identifier (e.g. connector ID) of the Case Alert.
GoogleSecOps.CaseAlert.ruleGeneratorStringThe third-party rule that triggered the Case Alert.
GoogleSecOps.CaseAlert.siemAlertIdStringThe SIEM alert identifier of the Case Alert.
GoogleSecOps.CaseAlert.sourceUrlStringThe source URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceRuleUrlStringThe source rule URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceSystemUrlStringThe source system URL of the Case Alert.
GoogleSecOps.CaseAlert.sourceRuleIdentifierStringThe source rule identifier of the Case Alert.
GoogleSecOps.CaseAlert.ticketIdStringThe ticket ID linked to the Case Alert in the integrated ticketing system.
GoogleSecOps.CaseAlert.additionalPropertiesStringThe additional connector data of the Case Alert as a JSON string.
GoogleSecOps.CaseAlert.priorityStringThe priority of the Case Alert.
GoogleSecOps.CaseAlert.statusStringThe status of the Case Alert.
GoogleSecOps.CaseAlert.manualBooleanWhether the Case Alert was created manually.
GoogleSecOps.CaseAlert.nestingDepthNumberThe nesting depth level of the Case Alert.
GoogleSecOps.CaseAlert.playbookStatusStringThe playbook or workflow status of the Case Alert.
GoogleSecOps.CaseAlert.attachedPlaybookNameStringThe name of the playbook attached to the Case Alert.
GoogleSecOps.CaseAlert.eventCountNumberThe number of events that triggered the Case Alert.
GoogleSecOps.CaseAlert.playbookRunCountNumberThe number of times the first playbook was run for the Case Alert.
GoogleSecOps.CaseAlert.createTimeStringThe creation time of the Case Alert (unix epoch milliseconds).
GoogleSecOps.CaseAlert.updateTimeStringThe last update time of the Case Alert (unix epoch milliseconds).
GoogleSecOps.CaseAlert.startTimeStringThe time the alert was created on the third-party system.
GoogleSecOps.CaseAlert.endTimeStringThe time the alert was closed on the third-party system.
GoogleSecOps.CaseAlert.sla.slaStatusStringThe SLA expiration status of the Case Alert.
GoogleSecOps.CaseAlert.sla.slaExpireTimeStringThe SLA expiration time of the Case Alert.
GoogleSecOps.CaseAlert.tags.tagStringThe tag value associated with the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.reasonStringThe closure reason of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.commentStringThe closure comment of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.rootCauseStringThe root cause provided at closure of the Case Alert.
GoogleSecOps.CaseAlert.closureDetails.closingTimeMsStringThe closure time of the Case Alert in Unix milliseconds.
GoogleSecOps.CaseAlert.involvedRelations.identifierStringThe identifier of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.alertIdentifierStringThe identifier of the alert the Involved Relation belongs to.
GoogleSecOps.CaseAlert.involvedRelations.caseIdNumberThe Case ID the Involved Relation belongs to.
GoogleSecOps.CaseAlert.involvedRelations.relationTypeStringThe type of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.deviceProductStringThe product associated with the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.deviceVendorStringThe vendor associated with the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.categoryOutcomeStringThe category outcome of the Involved Relation (e.g. Blocked, Allowed).
GoogleSecOps.CaseAlert.involvedRelations.destinationPortStringThe destination port of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.eventClassIdStringThe event display name of the Involved Relation (e.g. Email Check, Data Exfiltration).
GoogleSecOps.CaseAlert.involvedRelations.startTimeStringThe start time of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.endTimeStringThe end time of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.additionalPropertiesStringThe additional data of the Involved Relation as a JSON string.
GoogleSecOps.CaseAlert.involvedRelations.from.identifierStringThe identifier of the source entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.from.typeStringThe type of the source entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.to.identifierStringThe identifier of the destination entity of the Involved Relation.
GoogleSecOps.CaseAlert.involvedRelations.to.typeStringThe type of the destination entity of the Involved Relation.

Command example#

!gcb-case-alert-update case_id=1001 alert_id=1000001 status=CLOSE priority=HIGH close_reason=NOT_MALICIOUS close_comment="Reviewed and confirmed as false positive." root_cause="Misconfigured DLP policy"

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"alertId": "1000001",
"identifier": "TEST ALERT_00000000-0000-0000-0000-000000000010",
"caseId": 1001,
"createTime": "1778778979232",
"updateTime": "1779426987796",
"ruleGenerator": "Test-Alert-Rule-01",
"sourceGroupingIdentifier": "0.0.0.1",
"product": "Test Product",
"displayName": "TEST ALERT",
"vendor": "Test Vendor",
"environment": "Default Environment",
"ticketId": "0.0.0.1_2026-05-10 08:00:00",
"sourceSystemName": "Test Source System",
"closureDetails": {
"reason": "NOT_MALICIOUS",
"comment": "Reviewed and confirmed as false positive.",
"rootCause": "Misconfigured DLP policy",
"closingTimeMs": "1779447705049"
},
"sla": {
"expirationTime": "1780832620238",
"expirationStatus": "OPEN_SLA"
},
"priority": "HIGH",
"additionalProperties": "{\"Name\":\"TEST ALERT\",\"Type\":\"ALERT\"}",
"status": "CLOSE",
"startTime": "1778778979232",
"endTime": "1779426987796",
"alertGroupIdentifier": "TEST ALERT_00000000-0000-0000-0000-000000000010"
}
}
}

Human Readable Output#

Updated Case Alert Information#

Alert IDCase IDDisplay NameStatusPriorityProductVendorEnvironmentSLAAlert IdentifierAlert Group IdentifierCreate TimeUpdate TimeStart TimeEnd TimeManualRule GeneratorTicket IDSource System NameSource Grouping IdentifierAdditional PropertiesClosure Details
10000011001TEST ALERTCLOSEHIGHTest ProductTest VendorDefault EnvironmentStatus: OPEN_SLA
Expiration Time: 2026-06-07 11:43:40 UTC
TEST ALERT_00000000-0000-0000-0000-000000000010TEST ALERT_00000000-0000-0000-0000-0000000000102026-05-14 17:16:19 UTC2026-05-22 05:16:27 UTC2026-05-14 17:16:19 UTC2026-05-22 05:16:27 UTCFalseTest-Alert-Rule-010.0.0.1_2026-05-10 08:00:00Test Source System0.0.0.1{"Name":"TEST ALERT","Type":"ALERT"}reason: NOT_MALICIOUS
comment: Reviewed and confirmed as false positive.
rootCause: Misconfigured DLP policy
closingTimeMs: 1779447705049

gcb-case-alert-tag-add#


Add a tag to a case alert.

Base Command#

gcb-case-alert-tag-add

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to add a tag.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
tagSpecify the tag to add to the alert.Required

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.recentlyAddedTagStringThe recently added tag.

Command example#

!gcb-case-alert-tag-add case_id=1001 alert_id=1142656 tag=insider-threat

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"alertId": "1142656",
"caseId": 1001,
"recentlyAddedTag": "insider-threat"
}
}
}

Human Readable Output#

Tag insider-threat successfully added to alert 1142656.

gcb-case-alert-tag-remove#


Remove a tag from a case alert.

Base Command#

gcb-case-alert-tag-remove

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to remove a tag.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
tagSpecify the tag to remove from the alert.Required

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.recentlyRemovedTagStringThe tag that was recently removed from the case alert.

Command example#

!gcb-case-alert-tag-remove case_id=1001 alert_id=1142656 tag=insider-threat

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"alertId": "1142656",
"caseId": 1001,
"recentlyRemovedTag": "insider-threat"
}
}
}

Human Readable Output#

Tag insider-threat successfully removed from alert 1142656.

gcb-case-alert-move#


Move a case alert to a different case.

Note: Both source and destination cases must be open.

Base Command#

gcb-case-alert-move

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the source case.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to move.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
destination_case_idSpecify the destination case ID to move the alert to.

Note: Use gcb-case-list to retrieve destination case ID.
Required

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert.
GoogleSecOps.CaseAlert.caseIdNumberThe Case ID the alert was moved to.

Command example#

!gcb-case-alert-move case_id=1001 alert_id=1142656 destination_case_id=1005

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"alertId": "1142656",
"caseId": 1005
}
}
}

Human Readable Output#

Successfully moved Alert 1142656 to Case 1005.

gcb-case-alert-sla-pause#


Pause the SLA timer for the specified case alert.

Base Command#

gcb-case-alert-sla-pause

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to pause the SLA timer.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
messageSpecify the reason for pausing the SLA timer.Optional

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.slaExpirationStatusStringThe SLA expiration status of the Case Alert after the operation.

Command example#

!gcb-case-alert-sla-pause case_id=1001 alert_id=1142656 message="Pausing SLA pending additional investigation."

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"alertId": "1142656",
"caseId": "1001",
"slaExpirationStatus": "PAUSED"
}
}
}

Human Readable Output#

SLA timer for alert 1142656 successfully paused.

gcb-case-alert-sla-resume#


Resume the SLA timer for the specified case alert.

Base Command#

gcb-case-alert-sla-resume

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to resume the SLA timer.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.slaExpirationStatusStringThe SLA expiration status of the Case Alert after the operation.

Command example#

!gcb-case-alert-sla-resume case_id=1001 alert_id=1142656

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"alertId": "1142656",
"caseId": "1001",
"slaExpirationStatus": "SLA_EXPIRATION_STATUS_UNSPECIFIED"
}
}
}

Human Readable Output#

SLA timer for alert 1142656 successfully resumed.

gcb-case-alert-sla-set#


Set the SLA parameters for a case alert.

Note: When critical_time is specified, total_time must be greater than critical_time.

Base Command#

gcb-case-alert-sla-set

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to set the SLA.

Note: The alert must be open. Use gcb-case-alert-list to retrieve alert ID.
Required
total_timeSpecify the total SLA duration.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ. For example: 2 weeks, 01 May 2026, 2026-05-17T14:05:44Z.
Required
critical_timeSpecify the critical SLA threshold.

Note: Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ. For example: 2 weeks, 01 May 2026, 2026-05-17T14:05:44Z.
Optional

Context Output#

PathTypeDescription
GoogleSecOps.CaseAlert.alertIdStringThe ID of the Case Alert.
GoogleSecOps.CaseAlert.caseIdNumberThe ID of the Case the alert belongs to.
GoogleSecOps.CaseAlert.slaExpirationTimeStringThe SLA expiration time of the Case Alert (epoch ms).
GoogleSecOps.CaseAlert.slaCriticalExpirationTimeStringThe SLA critical expiration time of the Case Alert (epoch ms).

Command example#

!gcb-case-alert-sla-set case_id=1001 alert_id=1142656 total_time="2 days" critical_time="1 day"

Context Example#

{
"GoogleSecOps": {
"CaseAlert": {
"alertId": "1142656",
"caseId": "1001",
"slaExpirationTime": "1746266400000",
"slaCriticalExpirationTime": "1746180000000"
}
}
}

Human Readable Output#

SLA for Alert 1142656 successfully set.


gcb-case-alert-recommendation-create#


Initiate an asynchronous AI recommendation for a case alert.

Base Command#

gcb-case-alert-recommendation-create

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to generate a recommendation.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required

Context Output#

PathTypeDescription
GoogleSecOps.AlertRecommendation.parentStringThe resource name of the Case Alert the recommendation belongs to.
GoogleSecOps.AlertRecommendation.recommendationIdStringThe ID of the created recommendation.

Command example#

!gcb-case-alert-recommendation-create case_id=1001 alert_id=1000001

Context Example#

{
"GoogleSecOps": {
"AlertRecommendation": {
"recommendationId": "00000000-0000-0000-0000-000000000001"
}
}
}

Human Readable Output#

Successfully created the recommendation for the alert 1000001.

Recommendation ID: 00000000-0000-0000-0000-000000000001

gcb-case-alert-recommendation-fetch#


Fetch a previously generated AI recommendation for a case alert.

Base Command#

gcb-case-alert-recommendation-fetch

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
recommendation_idSpecify the recommendation ID returned by gcb-case-alert-recommendation-create command.Required

Context Output#

PathTypeDescription
GoogleSecOps.AlertRecommendation.parentStringThe resource name of the Case Alert the recommendation belongs to.
GoogleSecOps.AlertRecommendation.recommendationIdStringThe ID of the recommendation.
GoogleSecOps.AlertRecommendation.recommendationStringThe AI-generated recommendation text for the Case Alert.
GoogleSecOps.AlertRecommendation.alertIdentifierToCaseIdUnknownMapping of alert identifiers to their associated Case IDs.
GoogleSecOps.AlertRecommendation.marketplaceActionsTriggeredManuallyUnknownList of marketplace actions that were manually triggered on the alert.
GoogleSecOps.AlertRecommendation.stateStringThe current state of the recommendation generation.

Command example#

!gcb-case-alert-recommendation-fetch case_id=1001 recommendation_id=00000000-0000-0000-0000-000000001000

Context Example#

{
"GoogleSecOps": {
"AlertRecommendation": {
"recommendationId": "00000000-0000-0000-0000-000000001000",
"recommendation": "*Step 1: Closure Recommendation*\n\nClose the alert as \"Malicious\".",
"alertIdentifierToCaseId": {
"sample_alert_00000000-0000-0000-0000-000000000001": 100001,
"sample_alert_00000000-0000-0000-0000-000000000002": 100002
},
"marketplaceActionsTriggeredManually": [
"Enrich Web Properties",
"Enrich IPs"
],
"state": "SUCCEEDED"
}
}
}

Human Readable Output#

Alert Recommendation#


State: SUCCEEDED


Recommendation: Step 1: Closure Recommendation

Close the alert as "Malicious".


Alert Identifier To Case ID:

  • sample_alert_00000000-0000-0000-0000-000000000001: 100001
  • sample_alert_00000000-0000-0000-0000-000000000002: 100002

Marketplace Actions Triggered Manually: Enrich Web Properties, Enrich IPs

gcb-case-alert-customfield-list#


Retrieve the list of custom field values associated with a case alert.

Base Command#

gcb-case-alert-customfield-list

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case the alert belongs to.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to list custom field values.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
page_sizeSpecify the maximum number of custom field values to return.

Note: Maximum value is 1000. Default is 50.
Optional
page_tokenSpecify the page token for pagination.

Note: Use the next_page_token from a previous gcb-case-alert-customfield-list response.
Optional

Context Output#

PathTypeDescription
GoogleSecOps.AlertCustomFieldValue.nameStringThe unique resource name of the Custom Field Value.
GoogleSecOps.AlertCustomFieldValue.customFieldIdStringThe ID of the parent Custom Field.
GoogleSecOps.AlertCustomFieldValue.displayNameStringThe display name of the Custom Field resolved from the custom field ID.
GoogleSecOps.AlertCustomFieldValue.scopeStringThe scope of the Custom Field Value.
GoogleSecOps.AlertCustomFieldValue.scopeIdStringThe identifier of the scope (case or alert) this value references.
GoogleSecOps.AlertCustomFieldValue.valuesUnknownThe value(s) for the Custom Field.
GoogleSecOps.AlertCustomFieldValue.valuesSearchTextStringThe concatenated search text for all values of the Custom Field.
GoogleSecOps.PageToken.commandStringThe command name for which the page token applies.
GoogleSecOps.PageToken.nextPageTokenStringThe token to retrieve the next page of Custom Field Values.
GoogleSecOps.PageToken.totalSizeNumberThe total number of Custom Field Values available.

Command example#

!gcb-case-alert-customfield-list case_id=1001 alert_id=2001

Context Example#

{
"GoogleSecOps": {
"AlertCustomFieldValue": [
{
"customFieldId": "1",
"displayName": "Ticket Priority",
"scope": "ALERT",
"values": [
"High"
],
"valuesSearchText": "High"
},
{
"customFieldId": "2",
"displayName": "Escalation Required",
"scope": "ALERT",
"values": [
"Yes"
],
"valuesSearchText": "Yes"
},
{
"customFieldId": "3",
"displayName": "Affected Systems",
"scope": "ALERT",
"values": [
"Web Server",
"Database"
],
"valuesSearchText": "Web Server Database"
}
],
"PageToken": {
"command": "gcb-case-alert-customfield-list",
"nextPageToken": "test-next-page-token",
"totalSize": 10
}
}
}

Human Readable Output#

Case Alert Custom Field Values#

Custom Field IDDisplay NameValuesValues Search Text
1Ticket PriorityHighHigh
2Escalation RequiredYesYes
3Affected SystemsWeb Server, DatabaseWeb Server Database

Maximum number of custom field values specified in page_size has been returned. To fetch the next set of custom field values, execute the command with the page token as test-next-page-token.

gcb-case-alert-entity-list#


Retrieve the list of entities associated with a case alert.

Base Command#

gcb-case-alert-entity-list

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert to list entities.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
page_sizeSpecify the maximum number of entities to return.

Note: Maximum value is 1000. Default is 50.
Optional
page_tokenSpecify the page token for pagination.

Note: Use the next_page_token from a previous gcb-case-alert-entity-list response.
Optional
entity_typeFilter entities by type. Supports comma-separated values. Possible values are: ADDRESS, HOSTNAME, PROCESS, USB.Optional
suspiciousFilter entities by suspicious status. Possible values are: true, false.Optional
internalFilter entities by internal status. Possible values are: true, false.Optional
attackerFilter entities by attacker designation. Possible values are: true, false.Optional
pivotFilter entities by pivot designation. Possible values are: true, false.Optional
enrichedFilter entities by enrichment status. Possible values are: true, false.Optional
artifactFilter entities by artifact flag. Possible values are: true, false.Optional
vulnerableFilter entities by vulnerable flag. Possible values are: true, false.Optional
manually_createdFilter entities by manually created flag. Possible values are: true, false.Optional
threat_sourceFilter entities by threat source. Supports comma-separated values.Optional
operating_systemFilter entities by operating system. Supports comma-separated values.Optional
network_titleFilter entities by network name. Supports comma-separated values.Optional
network_priorityFilter entities by network priority (integer values). Supports comma-separated values.Optional
environmentFilter entities by environment. Supports comma-separated values.Optional
advanced_filterSpecify a raw filter expression to query entities with advanced conditions. When provided, this filter is used as-is and all other filter arguments are ignored.

Note: Supported filter fields: type, suspicious, internal, attacker, pivot, enriched, artifact, vulnerable, manuallyCreated, threatSource, operatingSystem, networkTitle, networkPriority, environment, fields.

Example: type='ADDRESS' AND suspicious=true AND internal=false.
Optional
sort_bySpecify the field to sort results by. Possible values are: id, entityType, suspicious, internal, attacker, pivot, enriched, artifact, vulnerable, manuallyCreated, threatSource, operatingSystem, networkTitle, networkPriority, environment. Default is id.Optional
sort_orderSpecify the sort direction for the results. Possible values are: Asc, Desc. Default is Desc.Optional
filter_logicSpecify the logical operator to combine filter conditions. Possible values are: AND, OR. Default is AND.Optional

Context Output#

PathTypeDescription
GoogleSecOps.AlertEntity.idStringThe immutable identifier of the Involved Entity.
GoogleSecOps.AlertEntity.identifierStringThe identifier name of the Involved Entity.
GoogleSecOps.AlertEntity.typeStringThe type of the Involved Entity.
GoogleSecOps.AlertEntity.caseIdNumberThe Case ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.alertIdentifierStringThe alert identifier the Involved Entity belongs to.
GoogleSecOps.AlertEntity.environmentStringThe environment of the Involved Entity.
GoogleSecOps.AlertEntity.threatSourceStringThe threat source associated with the Involved Entity.
GoogleSecOps.AlertEntity.operatingSystemStringThe operating system of the Involved Entity.
GoogleSecOps.AlertEntity.networkTitleStringThe network name related to the Involved Entity.
GoogleSecOps.AlertEntity.networkPriorityNumberThe network priority of the Involved Entity.
GoogleSecOps.AlertEntity.entityUriStringThe full URL of the Involved Entity in the source system.
GoogleSecOps.AlertEntity.sourceSystemUriStringThe source system URI link of the Involved Entity.
GoogleSecOps.AlertEntity.additionalPropertiesStringThe additional properties of the Involved Entity as a JSON string.
GoogleSecOps.AlertEntity.suspiciousBooleanWhether the Involved Entity is considered suspicious.
GoogleSecOps.AlertEntity.internalBooleanWhether the Involved Entity is internal.
GoogleSecOps.AlertEntity.attackerBooleanWhether the Involved Entity represents an attacker.
GoogleSecOps.AlertEntity.pivotBooleanWhether the Involved Entity is a pivot entity common to multiple cases.
GoogleSecOps.AlertEntity.manuallyCreatedBooleanWhether the Involved Entity was added manually.
GoogleSecOps.AlertEntity.enrichedBooleanWhether the Involved Entity has been enriched by an external action.
GoogleSecOps.AlertEntity.artifactBooleanWhether the Involved Entity is an artifact.
GoogleSecOps.AlertEntity.vulnerableBooleanWhether the Involved Entity is vulnerable.
GoogleSecOps.AlertEntity.fields.displayNameStringThe display name of the context group of the Involved Entity.
GoogleSecOps.AlertEntity.fields.highlightedBooleanWhether the context group of the Involved Entity is highlighted.
GoogleSecOps.AlertEntity.fields.hiddenBooleanWhether the context group of the Involved Entity is hidden.
GoogleSecOps.AlertEntity.fields.items.nameStringThe property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.originalNameStringThe original property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.valueStringThe value of the context group item of the Involved Entity.
GoogleSecOps.PageToken.commandStringThe command name associated with the pagination token.
GoogleSecOps.PageToken.nextPageTokenStringToken to fetch the next page of alert entities.
GoogleSecOps.PageToken.totalSizeNumberThe total number of alert entities available.

Command example#

!gcb-case-alert-entity-list case_id=306082 alert_id=1001

Context Example#

{
"GoogleSecOps": {
"AlertEntity": [
{
"id": "376359",
"type": "ADDRESS",
"suspicious": true,
"internal": true,
"networkPriority": 0,
"attacker": false,
"pivot": false,
"environment": "Default Environment",
"manuallyCreated": false,
"additionalProperties": "{\"Type\":\"ADDRESS\",\"IsArtifact\":\"False\",\"IsEnriched\":\"False\",\"IsVulnerable\":\"False\",\"IsInternalAsset\":\"True\",\"OriginalIdentifier\":\"999.999.999.999\"}",
"enriched": false,
"artifact": false,
"vulnerable": false,
"entityUri": "/entity?indicator=999.999.999.999&type=ipAddress",
"fields": [
{
"displayName": "Default",
"highlighted": false,
"hidden": false,
"items": [
{"name": "Network_Priority", "originalName": "Network_Priority", "value": "0"},
{"name": "IsSuspicious", "originalName": "IsSuspicious", "value": "True"}
]
},
{
"displayName": "Entity",
"highlighted": false,
"hidden": false,
"items": [
{"name": "Is Pivot", "originalName": "IsPivot", "value": "False"}
]
}
],
"alertIdentifier": "Testing Alert_62923d4f-05f0-47bf-9290-d0c94406e775",
"caseId": 306082,
"identifier": "999.999.999.999"
},
{
"id": "376358",
"type": "ADDRESS",
"suspicious": false,
"internal": false,
"networkPriority": 0,
"attacker": false,
"pivot": false,
"environment": "Default Environment",
"manuallyCreated": false,
"additionalProperties": "{\"Type\":\"ADDRESS\",\"IsArtifact\":\"False\",\"IsEnriched\":\"True\",\"Censys_ports\":\"53, 443, 853\",\"IsVulnerable\":\"False\",\"IsInternalAsset\":\"False\",\"OriginalIdentifier\":\"8.8.8.8\"}",
"enriched": true,
"artifact": false,
"vulnerable": false,
"entityUri": "/entity?indicator=8.8.8.8&type=ipAddress",
"fields": [
{
"displayName": "Default",
"highlighted": false,
"hidden": false,
"items": [
{"name": "Network_Priority", "originalName": "Network_Priority", "value": "0"},
{"name": "IsSuspicious", "originalName": "IsSuspicious", "value": "False"}
]
},
{
"displayName": "Entity",
"highlighted": false,
"hidden": false,
"items": [
{"name": "Is Pivot", "originalName": "IsPivot", "value": "False"}
]
}
],
"alertIdentifier": "Testing Alert_62923d4f-05f0-47bf-9290-d0c94406e775",
"caseId": 306082,
"identifier": "8.8.8.8"
}
]
}
}

Human Readable Output#

Alert Entities List#

IDIdentifierTypeEnvironmentSuspiciousInternalAttackerPivotEnrichedArtifactVulnerableManually CreatedNetwork PriorityEntity URI
376359999.999.999.999ADDRESSDefault EnvironmentTrueTrueFalseFalseFalseFalseFalseFalse0/entity?indicator=999.999.999.999&type=ipAddress
3763588.8.8.8ADDRESSDefault EnvironmentFalseFalseFalseFalseTrueFalseFalseFalse0/entity?indicator=8.8.8.8&type=ipAddress

gcb-case-alert-entity-get#


Retrieve detailed information about a specific involved entity in a case alert.

Base Command#

gcb-case-alert-entity-get

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
entity_idSpecify the ID of the involved entity to retrieve.

Note: Use gcb-case-alert-entity-list to retrieve entity ID.
Required

Context Output#

PathTypeDescription
GoogleSecOps.AlertEntity.idStringThe immutable identifier of the Involved Entity.
GoogleSecOps.AlertEntity.identifierStringThe identifier name of the Involved Entity.
GoogleSecOps.AlertEntity.typeStringThe type of the Involved Entity.
GoogleSecOps.AlertEntity.alertIdStringThe Alert ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.caseIdNumberThe Case ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.alertIdentifierStringThe alert identifier the Involved Entity belongs to.
GoogleSecOps.AlertEntity.environmentStringThe environment of the Involved Entity.
GoogleSecOps.AlertEntity.threatSourceStringThe threat source associated with the Involved Entity.
GoogleSecOps.AlertEntity.operatingSystemStringThe operating system of the Involved Entity.
GoogleSecOps.AlertEntity.networkTitleStringThe network name related to the Involved Entity.
GoogleSecOps.AlertEntity.networkPriorityNumberThe network priority of the Involved Entity.
GoogleSecOps.AlertEntity.entityUriStringThe full URL of the Involved Entity in the source system.
GoogleSecOps.AlertEntity.sourceSystemUriStringThe source system URI link of the Involved Entity.
GoogleSecOps.AlertEntity.additionalPropertiesStringThe additional properties of the Involved Entity as a JSON string.
GoogleSecOps.AlertEntity.suspiciousBooleanWhether the Involved Entity is considered suspicious.
GoogleSecOps.AlertEntity.internalBooleanWhether the Involved Entity is internal.
GoogleSecOps.AlertEntity.attackerBooleanWhether the Involved Entity represents an attacker.
GoogleSecOps.AlertEntity.pivotBooleanWhether the Involved Entity is a pivot entity common to multiple cases.
GoogleSecOps.AlertEntity.manuallyCreatedBooleanWhether the Involved Entity was added manually.
GoogleSecOps.AlertEntity.enrichedBooleanWhether the Involved Entity has been enriched by an external action.
GoogleSecOps.AlertEntity.artifactBooleanWhether the Involved Entity is an artifact.
GoogleSecOps.AlertEntity.vulnerableBooleanWhether the Involved Entity is vulnerable.
GoogleSecOps.AlertEntity.fields.displayNameStringThe display name of the context group of the Involved Entity.
GoogleSecOps.AlertEntity.fields.highlightedBooleanWhether the context group of the Involved Entity is highlighted.
GoogleSecOps.AlertEntity.fields.hiddenBooleanWhether the context group of the Involved Entity is hidden.
GoogleSecOps.AlertEntity.fields.items.nameStringThe property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.originalNameStringThe original property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.valueStringThe value of the context group item of the Involved Entity.

Command example#

!gcb-case-alert-entity-get case_id=306082 alert_id=1001 entity_id=376359

Context Example#

{
"GoogleSecOps": {
"AlertEntity": {
"id": "376359",
"type": "ADDRESS",
"suspicious": false,
"internal": false,
"networkPriority": 0,
"attacker": false,
"pivot": false,
"environment": "Default Environment",
"manuallyCreated": false,
"additionalProperties": "{\"Type\":\"ADDRESS\",\"IsArtifact\":\"False\",\"IsEnriched\":\"False\",\"IsVulnerable\":\"False\",\"IsInternalAsset\":\"False\",\"OriginalIdentifier\":\"999.999.999.999\"}",
"enriched": false,
"artifact": false,
"vulnerable": false,
"entityUri": "/entity?indicator=999.999.999.999&type=ipAddress",
"fields": [
{
"displayName": "Default",
"highlighted": false,
"hidden": false,
"items": [
{
"name": "Network_Priority",
"originalName": "Network_Priority",
"value": "0"
},
{
"name": "IsSuspicious",
"originalName": "IsSuspicious",
"value": "False"
},
{
"name": "IsAttacker",
"originalName": "IsAttacker",
"value": "False"
},
{
"name": "IsManuallyCreated",
"originalName": "IsManuallyCreated",
"value": "False"
},
{
"name": "Environment",
"originalName": "Environment",
"value": "Default Environment"
},
{
"name": "Alert_Id",
"originalName": "Alert_Id",
"value": "Testing Alert_62923d4f-05f0-47bf-9290-d0c94406e775"
},
{
"name": "Type",
"originalName": "Type",
"value": "ADDRESS"
},
{
"name": "IsArtifact",
"originalName": "IsArtifact",
"value": "False"
},
{
"name": "IsEnriched",
"originalName": "IsEnriched",
"value": "False"
},
{
"name": "IsVulnerable",
"originalName": "IsVulnerable",
"value": "False"
},
{
"name": "IsInternalAsset",
"originalName": "IsInternalAsset",
"value": "False"
},
{
"name": "OriginalIdentifier",
"originalName": "OriginalIdentifier",
"value": "999.999.999.999"
}
]
},
{
"displayName": "Entity",
"highlighted": false,
"hidden": false,
"items": [
{
"name": "Is Pivot",
"originalName": "IsPivot",
"value": "False"
}
]
}
],
"alertIdentifier": "Testing Alert_62923d4f-05f0-47bf-9290-d0c94406e775",
"caseId": 306082,
"alertId": "1001",
"identifier": "999.999.999.999"
}
}
}

Human Readable Output#

Entity Information#

IDIdentifierAlert IDCase IDAlert IdentifierTypeEnvironmentSuspiciousInternalAttackerPivotEnrichedArtifactVulnerableManually CreatedNetwork PriorityEntity URIAdditional PropertiesFields
376359999.999.999.9991001306082Testing Alert_62923d4f-05f0-47bf-9290-d0c94406e775ADDRESSDefault EnvironmentFalseFalseFalseFalseFalseFalseFalseFalse0/entity?indicator=999.999.999.999&type=ipAddress{"Type":"ADDRESS","IsArtifact":"False","IsEnriched":"False","IsVulnerable":"False","IsInternalAsset":"False","OriginalIdentifier":"999.999.999.999"}- displayName: Default
highlighted: False
hidden: False
items:
- name: Network_Priority
originalName: Network_Priority
value: 0
- name: IsSuspicious
originalName: IsSuspicious
value: False
- name: IsAttacker
originalName: IsAttacker
value: False
- name: IsManuallyCreated
originalName: IsManuallyCreated
value: False
- name: Environment
originalName: Environment
value: Default Environment
- name: Alert_Id
originalName: Alert_Id
value: Testing Alert_62923d4f-05f0-47bf-9290-d0c94406e775
- name: Type
originalName: Type
value: ADDRESS
- name: IsArtifact
originalName: IsArtifact
value: False
- name: IsEnriched
originalName: IsEnriched
value: False
- name: IsVulnerable
originalName: IsVulnerable
value: False
- name: IsInternalAsset
originalName: IsInternalAsset
value: False
- name: OriginalIdentifier
originalName: OriginalIdentifier
value: 999.999.999.999
- displayName: Entity
highlighted: False
hidden: False
items:
- name: Is Pivot
originalName: IsPivot
value: False

gcb-case-alert-entity-create#


Manually create a new involved entity within a case alert.

Base Command#

gcb-case-alert-entity-create

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
identifierSpecify the identifier name of the entity (e.g. IP address, hostname value, process name).Required
entity_typeSpecify the type of the new entity.

Note: Immutable after creation. Possible values are: ADDRESS, HOSTNAME, PROCESS, USB.
Required
suspiciousSpecify whether the entity is suspicious. Possible values are: true, false. Default is false.Optional
internalSpecify whether the entity is internal to the organization. Possible values are: true, false. Default is false.Optional
attackerSpecify whether the entity represents an attacker. Possible values are: true, false.Optional
pivotSpecify whether the entity is a pivot entity common to multiple cases. Possible values are: true, false.Optional
operating_systemSpecify the operating system of the entity.Optional
network_titleSpecify the network name related to the entity.Optional
threat_sourceSpecify the threat source name associated with the entity.Optional
network_prioritySpecify the network priority of the entity (non-negative integer).Optional

Context Output#

PathTypeDescription
GoogleSecOps.AlertEntity.idStringThe immutable identifier of the Involved Entity.
GoogleSecOps.AlertEntity.identifierStringThe identifier name of the Involved Entity.
GoogleSecOps.AlertEntity.typeStringThe type of the Involved Entity.
GoogleSecOps.AlertEntity.alertIdStringThe Alert ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.caseIdNumberThe Case ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.alertIdentifierStringThe alert identifier the Involved Entity belongs to.
GoogleSecOps.AlertEntity.environmentStringThe environment of the Involved Entity.
GoogleSecOps.AlertEntity.threatSourceStringThe threat source associated with the Involved Entity.
GoogleSecOps.AlertEntity.operatingSystemStringThe operating system of the Involved Entity.
GoogleSecOps.AlertEntity.networkTitleStringThe network name related to the Involved Entity.
GoogleSecOps.AlertEntity.networkPriorityNumberThe network priority of the Involved Entity.
GoogleSecOps.AlertEntity.entityUriStringThe full URL of the Involved Entity in the source system.
GoogleSecOps.AlertEntity.sourceSystemUriStringThe source system URI link of the Involved Entity.
GoogleSecOps.AlertEntity.additionalPropertiesStringThe additional properties of the Involved Entity as a JSON string.
GoogleSecOps.AlertEntity.suspiciousBooleanWhether the Involved Entity is considered suspicious.
GoogleSecOps.AlertEntity.internalBooleanWhether the Involved Entity is internal.
GoogleSecOps.AlertEntity.attackerBooleanWhether the Involved Entity represents an attacker.
GoogleSecOps.AlertEntity.pivotBooleanWhether the Involved Entity is a pivot entity common to multiple cases.
GoogleSecOps.AlertEntity.manuallyCreatedBooleanWhether the Involved Entity was added manually.
GoogleSecOps.AlertEntity.enrichedBooleanWhether the Involved Entity has been enriched by an external action.
GoogleSecOps.AlertEntity.artifactBooleanWhether the Involved Entity is an artifact.
GoogleSecOps.AlertEntity.vulnerableBooleanWhether the Involved Entity is vulnerable.
GoogleSecOps.AlertEntity.fields.displayNameStringThe display name of the context group of the Involved Entity.
GoogleSecOps.AlertEntity.fields.highlightedBooleanWhether the context group of the Involved Entity is highlighted.
GoogleSecOps.AlertEntity.fields.hiddenBooleanWhether the context group of the Involved Entity is hidden.
GoogleSecOps.AlertEntity.fields.items.nameStringThe property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.originalNameStringThe original property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.valueStringThe value of the context group item of the Involved Entity.

Command example#

!gcb-case-alert-entity-create case_id=123456 alert_id=1001 identifier=192.0.2.1 entity_type=ADDRESS suspicious=true

Context Example#

{
"GoogleSecOps": {
"AlertEntity": {
"id": "111111",
"type": "ADDRESS",
"suspicious": true,
"internal": false,
"networkPriority": 0,
"attacker": false,
"pivot": false,
"environment": "Default Environment",
"manuallyCreated": true,
"additionalProperties": "{\"Type\":\"ADDRESS\",\"IsArtifact\":\"False\",\"IsEnriched\":\"False\",\"IsVulnerable\":\"False\",\"IsInternalAsset\":\"False\",\"OriginalIdentifier\":\"192.0.2.1\"}",
"enriched": false,
"artifact": false,
"vulnerable": false,
"fields": [
{
"displayName": "Default",
"highlighted": false,
"hidden": false,
"items": [
{
"name": "Network_Priority",
"originalName": "Network_Priority",
"value": "0"
},
{
"name": "IsSuspicious",
"originalName": "IsSuspicious",
"value": "True"
},
{
"name": "IsAttacker",
"originalName": "IsAttacker",
"value": "False"
},
{
"name": "IsManuallyCreated",
"originalName": "IsManuallyCreated",
"value": "True"
},
{
"name": "Environment",
"originalName": "Environment",
"value": "Default Environment"
},
{
"name": "Alert_Id",
"originalName": "Alert_Id",
"value": "Testing Alert_00000000-0000-0000-0000-000000000001"
}
]
},
{
"displayName": "Entity",
"highlighted": false,
"hidden": false,
"items": [
{
"name": "Is Pivot",
"originalName": "IsPivot",
"value": "False"
}
]
}
],
"alertIdentifier": "Testing Alert_00000000-0000-0000-0000-000000000001",
"caseId": 123456,
"alertId": "1001",
"identifier": "192.0.2.1"
}
}
}

Human Readable Output#

Entity Information#

IDIdentifierAlert IDCase IDAlert IdentifierTypeEnvironmentSuspiciousInternalAttackerPivotEnrichedArtifactVulnerableManually CreatedNetwork PriorityAdditional PropertiesFields
111111192.0.2.11001123456Testing Alert_00000000-0000-0000-0000-000000000001ADDRESSDefault EnvironmentTrueFalseFalseFalseFalseFalseFalseTrue0{"Type":"ADDRESS","IsArtifact":"False","IsEnriched":"False","IsVulnerable":"False","IsInternalAsset":"False","OriginalIdentifier":"192.0.2.1"}- displayName: Default
highlighted: False
hidden: False
items:
- name: Network_Priority
originalName: Network_Priority
value: 0
- name: IsSuspicious
originalName: IsSuspicious
value: True
- name: IsAttacker
originalName: IsAttacker
value: False
- name: IsManuallyCreated
originalName: IsManuallyCreated
value: True
- name: Environment
originalName: Environment
value: Default Environment
- name: Alert_Id
originalName: Alert_Id
value: Testing Alert_00000000-0000-0000-0000-000000000001
- displayName: Entity
highlighted: False
hidden: False
items:
- name: Is Pivot
originalName: IsPivot
value: False

gcb-case-alert-entity-update#


Update the attributes of an existing involved entity in a case alert.

Base Command#

gcb-case-alert-entity-update

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
entity_idSpecify the ID of the involved entity to update.

Note: Use gcb-case-alert-entity-list to retrieve entity ID.
Required
suspiciousSpecify the updated suspicion flag for the entity. Possible values are: true, false.Optional
internalSpecify the updated internal flag for the entity. Possible values are: true, false.Optional
attackerSpecify the updated attacker designation for the entity. Possible values are: true, false.Optional
pivotSpecify the updated pivot designation for the entity. Possible values are: true, false.Optional
operating_systemSpecify the updated operating system of the entity.Optional
network_titleSpecify the updated network name related to the entity.Optional
threat_sourceSpecify the updated threat source associated with the entity.Optional
network_prioritySpecify the updated network priority associated with the entity (non-negative integer).Optional

Context Output#

PathTypeDescription
GoogleSecOps.AlertEntity.idStringThe immutable identifier of the Involved Entity.
GoogleSecOps.AlertEntity.identifierStringThe identifier name of the Involved Entity.
GoogleSecOps.AlertEntity.typeStringThe type of the Involved Entity.
GoogleSecOps.AlertEntity.alertIdStringThe Alert ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.caseIdNumberThe Case ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.alertIdentifierStringThe alert identifier the Involved Entity belongs to.
GoogleSecOps.AlertEntity.environmentStringThe environment of the Involved Entity.
GoogleSecOps.AlertEntity.threatSourceStringThe threat source associated with the Involved Entity.
GoogleSecOps.AlertEntity.operatingSystemStringThe operating system of the Involved Entity.
GoogleSecOps.AlertEntity.networkTitleStringThe network name related to the Involved Entity.
GoogleSecOps.AlertEntity.networkPriorityNumberThe network priority of the Involved Entity.
GoogleSecOps.AlertEntity.entityUriStringThe full URL of the Involved Entity in the source system.
GoogleSecOps.AlertEntity.sourceSystemUriStringThe source system URI link of the Involved Entity.
GoogleSecOps.AlertEntity.additionalPropertiesStringThe additional properties of the Involved Entity as a JSON string.
GoogleSecOps.AlertEntity.suspiciousBooleanWhether the Involved Entity is considered suspicious.
GoogleSecOps.AlertEntity.internalBooleanWhether the Involved Entity is internal.
GoogleSecOps.AlertEntity.attackerBooleanWhether the Involved Entity represents an attacker.
GoogleSecOps.AlertEntity.pivotBooleanWhether the Involved Entity is a pivot entity common to multiple cases.
GoogleSecOps.AlertEntity.manuallyCreatedBooleanWhether the Involved Entity was added manually.
GoogleSecOps.AlertEntity.enrichedBooleanWhether the Involved Entity has been enriched by an external action.
GoogleSecOps.AlertEntity.artifactBooleanWhether the Involved Entity is an artifact.
GoogleSecOps.AlertEntity.vulnerableBooleanWhether the Involved Entity is vulnerable.
GoogleSecOps.AlertEntity.fields.displayNameStringThe display name of the context group of the Involved Entity.
GoogleSecOps.AlertEntity.fields.highlightedBooleanWhether the context group of the Involved Entity is highlighted.
GoogleSecOps.AlertEntity.fields.hiddenBooleanWhether the context group of the Involved Entity is hidden.
GoogleSecOps.AlertEntity.fields.items.nameStringThe property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.originalNameStringThe original property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.valueStringThe value of the context group item of the Involved Entity.

Command example#

!gcb-case-alert-entity-update case_id=306082 alert_id=1001 entity_id=376398 suspicious=true attacker=true network_priority=5

Context Example#

{
"GoogleSecOps": {
"AlertEntity": {
"id": "376398",
"type": "ADDRESS",
"suspicious": true,
"internal": false,
"networkPriority": 5,
"attacker": true,
"pivot": false,
"environment": "Default Environment",
"manuallyCreated": true,
"additionalProperties": "{\"Type\":\"ADDRESS\",\"IsArtifact\":\"False\",\"IsEnriched\":\"False\",\"IsVulnerable\":\"False\",\"IsInternalAsset\":\"False\",\"OriginalIdentifier\":\"192.0.2.1\"}",
"enriched": false,
"artifact": false,
"vulnerable": false,
"fields": [
{
"displayName": "Default",
"highlighted": false,
"hidden": false,
"items": [
{
"name": "Network_Priority",
"originalName": "Network_Priority",
"value": "5"
},
{
"name": "IsSuspicious",
"originalName": "IsSuspicious",
"value": "True"
},
{
"name": "IsAttacker",
"originalName": "IsAttacker",
"value": "True"
},
{
"name": "IsManuallyCreated",
"originalName": "IsManuallyCreated",
"value": "True"
},
{
"name": "Environment",
"originalName": "Environment",
"value": "Default Environment"
},
{
"name": "Alert_Id",
"originalName": "Alert_Id",
"value": "Testing Alert_00000000-0000-0000-0000-000000000001"
}
]
},
{
"displayName": "Entity",
"highlighted": false,
"hidden": false,
"items": [
{
"name": "Is Pivot",
"originalName": "IsPivot",
"value": "False"
}
]
}
],
"alertIdentifier": "Testing Alert_00000000-0000-0000-0000-000000000001",
"caseId": 306082,
"alertId": "1001",
"identifier": "192.0.2.1"
}
}
}

Human Readable Output#

Updated Entity Information#

IDIdentifierAlert IDCase IDAlert IdentifierTypeEnvironmentSuspiciousInternalAttackerPivotEnrichedArtifactVulnerableManually CreatedNetwork PriorityAdditional PropertiesFields
376398192.0.2.11001306082Testing Alert_00000000-0000-0000-0000-000000000001ADDRESSDefault EnvironmentTrueFalseTrueFalseFalseFalseFalseTrue5{"Type":"ADDRESS","IsArtifact":"False","IsEnriched":"False","IsVulnerable":"False","IsInternalAsset":"False","OriginalIdentifier":"192.0.2.1"}- displayName: Default
highlighted: False
hidden: False
items:
- name: Network_Priority
originalName: Network_Priority
value: 5
- name: IsSuspicious
originalName: IsSuspicious
value: True
- name: IsAttacker
originalName: IsAttacker
value: True
- name: IsManuallyCreated
originalName: IsManuallyCreated
value: True
- name: Environment
originalName: Environment
value: Default Environment
- name: Alert_Id
originalName: Alert_Id
value: Testing Alert_00000000-0000-0000-0000-000000000001
- displayName: Entity
highlighted: False
hidden: False
items:
- name: Is Pivot
originalName: IsPivot
value: False

gcb-case-alert-entity-property-add#


Add a new custom property to an involved entity in a case alert.

Base Command#

gcb-case-alert-entity-property-add

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
entity_idSpecify the ID of the involved entity to add a property.

Note: Use gcb-case-alert-entity-list to retrieve entity ID.
Required
keySpecify the property key to add.

Note: The key must not already exist on the entity.
Required
valueSpecify the value for the new property.Required

Context Output#

PathTypeDescription
GoogleSecOps.AlertEntity.idStringThe immutable identifier of the Involved Entity.
GoogleSecOps.AlertEntity.identifierStringThe identifier name of the Involved Entity.
GoogleSecOps.AlertEntity.typeStringThe type of the Involved Entity.
GoogleSecOps.AlertEntity.alertIdStringThe Alert ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.caseIdNumberThe Case ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.alertIdentifierStringThe alert identifier the Involved Entity belongs to.
GoogleSecOps.AlertEntity.environmentStringThe environment of the Involved Entity.
GoogleSecOps.AlertEntity.threatSourceStringThe threat source associated with the Involved Entity.
GoogleSecOps.AlertEntity.operatingSystemStringThe operating system of the Involved Entity.
GoogleSecOps.AlertEntity.networkTitleStringThe network name related to the Involved Entity.
GoogleSecOps.AlertEntity.networkPriorityNumberThe network priority of the Involved Entity.
GoogleSecOps.AlertEntity.entityUriStringThe full URL of the Involved Entity in the source system.
GoogleSecOps.AlertEntity.sourceSystemUriStringThe source system URI link of the Involved Entity.
GoogleSecOps.AlertEntity.additionalPropertiesStringThe additional properties of the Involved Entity as a JSON string.
GoogleSecOps.AlertEntity.suspiciousBooleanWhether the Involved Entity is considered suspicious.
GoogleSecOps.AlertEntity.internalBooleanWhether the Involved Entity is internal.
GoogleSecOps.AlertEntity.attackerBooleanWhether the Involved Entity represents an attacker.
GoogleSecOps.AlertEntity.pivotBooleanWhether the Involved Entity is a pivot entity common to multiple cases.
GoogleSecOps.AlertEntity.manuallyCreatedBooleanWhether the Involved Entity was added manually.
GoogleSecOps.AlertEntity.enrichedBooleanWhether the Involved Entity has been enriched by an external action.
GoogleSecOps.AlertEntity.artifactBooleanWhether the Involved Entity is an artifact.
GoogleSecOps.AlertEntity.vulnerableBooleanWhether the Involved Entity is vulnerable.
GoogleSecOps.AlertEntity.fields.displayNameStringThe display name of the context group of the Involved Entity.
GoogleSecOps.AlertEntity.fields.highlightedBooleanWhether the context group of the Involved Entity is highlighted.
GoogleSecOps.AlertEntity.fields.hiddenBooleanWhether the context group of the Involved Entity is hidden.
GoogleSecOps.AlertEntity.fields.items.nameStringThe property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.originalNameStringThe original property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.valueStringThe value of the context group item of the Involved Entity.

Command example#

!gcb-case-alert-entity-property-add case_id=306082 alert_id=1001 entity_id=376398 key=total_score value=42/72

Context Example#

{
"GoogleSecOps": {
"AlertEntity": {
"id": "376398",
"type": "ADDRESS",
"suspicious": true,
"internal": false,
"networkPriority": 5,
"attacker": true,
"pivot": false,
"environment": "Default Environment",
"manuallyCreated": true,
"additionalProperties": "{\"Type\":\"ADDRESS\",\"IsArtifact\":\"False\",\"IsEnriched\":\"False\",\"IsVulnerable\":\"False\",\"IsInternalAsset\":\"False\",\"OriginalIdentifier\":\"192.0.2.1\"}",
"enriched": true,
"artifact": false,
"vulnerable": false,
"fields": [
{
"displayName": "Default",
"highlighted": false,
"hidden": false,
"items": [
{"name": "Network_Priority", "originalName": "Network_Priority", "value": "5"},
{"name": "IsSuspicious", "originalName": "IsSuspicious", "value": "True"},
{"name": "IsAttacker", "originalName": "IsAttacker", "value": "True"},
{"name": "IsManuallyCreated", "originalName": "IsManuallyCreated", "value": "True"},
{"name": "Environment", "originalName": "Environment", "value": "Default Environment"},
{"name": "Alert_Id", "originalName": "Alert_Id", "value": "Testing Alert_00000000-0000-0000-0000-000000000001"}
]
},
{
"displayName": "Entity",
"highlighted": false,
"hidden": false,
"items": [{"name": "Is Pivot", "originalName": "IsPivot", "value": "False"}]
},
{
"displayName": "Enrichment",
"highlighted": false,
"hidden": false,
"items": [{"name": "Total Score", "originalName": "Total Score", "value": "42/72"}]
}
],
"alertIdentifier": "Testing Alert_00000000-0000-0000-0000-000000000001",
"caseId": 306082,
"alertId": "1001",
"identifier": "192.0.2.1"
}
}
}

Human Readable Output#

Added Entity Property with key total_score and value 42/72.

gcb-case-alert-entity-property-update#


Update an existing custom property value on an involved entity in a case alert.

Base Command#

gcb-case-alert-entity-property-update

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_idSpecify the ID of the case alert.

Note: Use gcb-case-alert-list to retrieve alert ID.
Required
entity_idSpecify the ID of the involved entity to update the property.

Note: Use gcb-case-alert-entity-list to retrieve entity ID.
Required
keySpecify the existing property key whose value should be updated.Required
valueSpecify the new value for the property.Required

Context Output#

PathTypeDescription
GoogleSecOps.AlertEntity.idStringThe immutable identifier of the Involved Entity.
GoogleSecOps.AlertEntity.identifierStringThe identifier name of the Involved Entity.
GoogleSecOps.AlertEntity.typeStringThe type of the Involved Entity.
GoogleSecOps.AlertEntity.alertIdStringThe Alert ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.caseIdNumberThe Case ID the Involved Entity belongs to.
GoogleSecOps.AlertEntity.alertIdentifierStringThe alert identifier the Involved Entity belongs to.
GoogleSecOps.AlertEntity.environmentStringThe environment of the Involved Entity.
GoogleSecOps.AlertEntity.threatSourceStringThe threat source associated with the Involved Entity.
GoogleSecOps.AlertEntity.operatingSystemStringThe operating system of the Involved Entity.
GoogleSecOps.AlertEntity.networkTitleStringThe network name related to the Involved Entity.
GoogleSecOps.AlertEntity.networkPriorityNumberThe network priority of the Involved Entity.
GoogleSecOps.AlertEntity.entityUriStringThe full URL of the Involved Entity in the source system.
GoogleSecOps.AlertEntity.sourceSystemUriStringThe source system URI link of the Involved Entity.
GoogleSecOps.AlertEntity.additionalPropertiesStringThe additional properties of the Involved Entity as a JSON string.
GoogleSecOps.AlertEntity.suspiciousBooleanWhether the Involved Entity is considered suspicious.
GoogleSecOps.AlertEntity.internalBooleanWhether the Involved Entity is internal.
GoogleSecOps.AlertEntity.attackerBooleanWhether the Involved Entity represents an attacker.
GoogleSecOps.AlertEntity.pivotBooleanWhether the Involved Entity is a pivot entity common to multiple cases.
GoogleSecOps.AlertEntity.manuallyCreatedBooleanWhether the Involved Entity was added manually.
GoogleSecOps.AlertEntity.enrichedBooleanWhether the Involved Entity has been enriched by an external action.
GoogleSecOps.AlertEntity.artifactBooleanWhether the Involved Entity is an artifact.
GoogleSecOps.AlertEntity.vulnerableBooleanWhether the Involved Entity is vulnerable.
GoogleSecOps.AlertEntity.fields.displayNameStringThe display name of the context group of the Involved Entity.
GoogleSecOps.AlertEntity.fields.highlightedBooleanWhether the context group of the Involved Entity is highlighted.
GoogleSecOps.AlertEntity.fields.hiddenBooleanWhether the context group of the Involved Entity is hidden.
GoogleSecOps.AlertEntity.fields.items.nameStringThe property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.originalNameStringThe original property name of the context group item of the Involved Entity.
GoogleSecOps.AlertEntity.fields.items.valueStringThe value of the context group item of the Involved Entity.

Command example#

!gcb-case-alert-entity-property-update case_id=306082 alert_id=1001 entity_id=376398 key=total_score value=68/72

Context Example#

{
"GoogleSecOps": {
"AlertEntity": {
"id": "376398",
"type": "ADDRESS",
"suspicious": true,
"internal": false,
"networkPriority": 5,
"attacker": true,
"pivot": false,
"environment": "Default Environment",
"manuallyCreated": true,
"additionalProperties": "{\"Type\":\"ADDRESS\",\"IsArtifact\":\"False\",\"IsEnriched\":\"False\",\"IsVulnerable\":\"False\",\"IsInternalAsset\":\"False\",\"OriginalIdentifier\":\"192.0.2.1\"}",
"enriched": true,
"artifact": false,
"vulnerable": false,
"fields": [
{
"displayName": "Default",
"highlighted": false,
"hidden": false,
"items": [
{"name": "Network_Priority", "originalName": "Network_Priority", "value": "5"},
{"name": "IsSuspicious", "originalName": "IsSuspicious", "value": "True"},
{"name": "IsAttacker", "originalName": "IsAttacker", "value": "True"},
{"name": "IsManuallyCreated", "originalName": "IsManuallyCreated", "value": "True"},
{"name": "Environment", "originalName": "Environment", "value": "Default Environment"},
{"name": "Alert_Id", "originalName": "Alert_Id", "value": "Testing Alert_00000000-0000-0000-0000-000000000001"}
]
},
{
"displayName": "Entity",
"highlighted": false,
"hidden": false,
"items": [{"name": "Is Pivot", "originalName": "IsPivot", "value": "False"}]
},
{
"displayName": "Enrichment",
"highlighted": false,
"hidden": false,
"items": [{"name": "Total Score", "originalName": "Total Score", "value": "68/72"}]
}
],
"alertIdentifier": "Testing Alert_00000000-0000-0000-0000-000000000001",
"caseId": 306082,
"alertId": "1001",
"identifier": "192.0.2.1"
}
}
}

Human Readable Output#

Updated Entity Property with key total_score and value 68/72.

gcb-playbook-list#


Retrieve the list of all playbooks that are currently enabled and ready for execution.

Base Command#

gcb-playbook-list

Input#

Argument NameDescriptionRequired
environmentFilter the playbooks by environment.Optional
execution_scopeFilter the playbooks attachable by the specified execution scope. Possible values are: ALERT, CASE, EXECUTION_SCOPE_UNSPECIFIED. Default is ALERT.Optional

Context Output#

PathTypeDescription
GoogleSecOps.Playbook.playbookNameStringThe name of the enabled playbook.
GoogleSecOps.Playbook.descriptionStringThe description of the playbook.
GoogleSecOps.Playbook.playbookTypeStringThe type of the playbook (REGULAR or NESTED).
GoogleSecOps.Playbook.originalWorkflowDefinitionIdentifierStringThe original workflow definition identifier of the playbook.
GoogleSecOps.Playbook.workflowDefinitionIdentifierStringThe workflow definition identifier of the playbook.
GoogleSecOps.Playbook.isDebugModeBooleanWhether the playbook is running in debug mode.

Command example#

!gcb-playbook-list execution_scope=ALERT

Context Example#

{
"GoogleSecOps": {
"Playbook": [
{
"playbookName": "IMPORT 5 - Network Containment Block - Google",
"description": "Automated IP containment playbook that queries Google using CVE identifiers, extracts malicious IPs, creates entities in alerts, and blocks them via Zscaler. Supports real-time threat intelligence-based network containment.",
"playbookType": "NESTED",
"isDebugMode": true,
"originalWorkflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000001",
"workflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000001"
},
{
"playbookName": "Google Cloud Compute Platform Starting Playbook",
"description": "Google Cloud Compute Platform Starting Playbook provides reference implementation of how Google Cloud Compute Platform alerts can be processed in Google SecOps.",
"playbookType": "REGULAR",
"isDebugMode": false,
"originalWorkflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000002",
"workflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000002"
},
{
"playbookName": "Set Initial Severity",
"description": "An embedded workflow that can receive inputs and return an output.",
"playbookType": "NESTED",
"isDebugMode": true,
"originalWorkflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000003",
"workflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000003"
},
{
"playbookName": "Google - Network Containment Block",
"description": "Automated IP containment playbook that queries Google using CVE identifiers, extracts malicious IPs, creates entities in alerts, and blocks them via Zscaler. Supports real-time threat intelligence-based network containment.",
"playbookType": "NESTED",
"isDebugMode": false,
"originalWorkflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000004",
"workflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000005"
}
]
}
}

Human Readable Output#

Enabled Playbooks#

Playbook NameDescriptionPlaybook TypeOriginal Workflow Definition IdentifierWorkflow Definition IdentifierIs Debug Mode
IMPORT 5 - Network Containment Block - GoogleAutomated IP containment playbook that queries Google using CVE identifiers, extracts malicious IPs, creates entities in alerts, and blocks them via Zscaler. Supports real-time threat intelligence-based network containment.NESTED00000000-0000-0000-0000-00000000000100000000-0000-0000-0000-000000000001True
Google Cloud Compute Platform Starting PlaybookGoogle Cloud Compute Platform Starting Playbook provides reference implementation of how Google Cloud Compute Platform alerts can be processed in Google SecOps.REGULAR00000000-0000-0000-0000-00000000000200000000-0000-0000-0000-000000000002False
Set Initial SeverityAn embedded workflow that can receive inputs and return an output.NESTED00000000-0000-0000-0000-00000000000300000000-0000-0000-0000-000000000003True
Google - Network Containment BlockAutomated IP containment playbook that queries Google using CVE identifiers, extracts malicious IPs, creates entities in alerts, and blocks them via Zscaler. Supports real-time threat intelligence-based network containment.NESTED00000000-0000-0000-0000-00000000000400000000-0000-0000-0000-000000000005False

gcb-playbook-attach#


Manually attach (trigger) a specific playbook to a case alert.

Base Command#

gcb-playbook-attach

Input#

Argument NameDescriptionRequired
case_idSpecify the ID of the case to attach the playbook.

Note: Use gcb-case-list to retrieve case ID.
Required
alert_group_identifierSpecify the alert group identifier of the case alert.

Note: Use gcb-case-alert-get to retrieve the alert group identifier.
Required
alert_identifierSpecify the alert identifier of the case alert.

Note: Use gcb-case-alert-get to retrieve the alert identifier.
Required
playbook_nameSpecify the name of the playbook (workflow) to attach.

Note: Use gcb-playbook-list to retrieve available playbook names.
Required
original_workflow_definition_identifierSpecify the original workflow definition identifier of the playbook.

Note: Use gcb-playbook-list to retrieve the original workflow definition identifier.
Optional

Context Output#

PathTypeDescription
GoogleSecOps.PlaybookAttach.caseIdStringThe Case ID the playbook was attached to.
GoogleSecOps.PlaybookAttach.alertGroupIdentifierStringThe alert group identifier the playbook was attached to.
GoogleSecOps.PlaybookAttach.alertIdentifierStringThe alert identifier the playbook was attached to.
GoogleSecOps.PlaybookAttach.playbookNameStringThe name of the playbook that was attached.
GoogleSecOps.PlaybookAttach.originalWorkflowDefinitionIdentifierStringThe original workflow definition identifier of the attached playbook.
GoogleSecOps.PlaybookAttach.successBooleanWhether the playbook was successfully attached to the alert.

Command example#

!gcb-playbook-attach case_id=1001 alert_group_identifier="Access Disabled Accounts_00000000-0000-0000-0000-000000000001" alert_identifier="ACCESS DISABLED ACCOUNTS_00000000-0000-0000-0000-000000000002" playbook_name="Phishing Investigation" original_workflow_definition_identifier="00000000-0000-0000-0000-000000000001"

Context Example#

{
"GoogleSecOps": {
"PlaybookAttach": {
"caseId": "1001",
"alertGroupIdentifier": "Access Disabled Accounts_00000000-0000-0000-0000-000000000001",
"alertIdentifier": "ACCESS DISABLED ACCOUNTS_00000000-0000-0000-0000-000000000002",
"playbookName": "Phishing Investigation",
"originalWorkflowDefinitionIdentifier": "00000000-0000-0000-0000-000000000001",
"success": true
}
}
}

Human Readable Output#

Playbook 'Phishing Investigation' successfully attached to alert ACCESS DISABLED ACCOUNTS_00000000-0000-0000-0000-000000000002 in case 1001.