Method: legacyPlaybooks.legacyAttachWorkflowToCase

Full name: projects.locations.instances.legacyPlaybooks.legacyAttachWorkflowToCase

legacyPlaybooks.legacyAttachWorkflowToCase attaches a workflow to a case.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to attach the workflow to case for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "cyberCaseId": string,
  "alertGroupIdentifier": string,
  "alertIdentifier": string,
  "wfName": string,
  "originalWorkflowDefinitionIdentifier": string,
  "shouldRunAutomatic": boolean
}
Fields
cyberCaseId

string (int64 format)

Required. The cyber case id.
alertGroupIdentifier

string

Required. The alert group identifier.
alertIdentifier

string

Required. The alert identifier.
wfName

string

Required. The workflow name.
originalWorkflowDefinitionIdentifier

string

Optional. The original workflow definition identifier.
shouldRunAutomatic

boolean

Required. Indicates if the workflow should run automatically.

Response body

LegacyPlaybookAttachWorkflowToCaseResponse is a response for attaching a workflow to a case.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": boolean
}
Fields
payload

boolean

Optional. The response is a boolean. True if the workflow was attached to the case successfully. False otherwise.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.legacyPlaybooks.update

For more information, see the IAM documentation.