Method: legacyPlaybooks.legacyGetCaseEntities

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

legacyPlaybooks.legacyGetCaseEntities get case entities.

HTTP request


Path parameters

Parameters
instance

string

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

Query parameters

Parameters
caseId

string (int64 format)

Required. The caseId is the identifier of the case.

Request body

The request body must be empty.

Response body

ApiCaseEntities represents a list of entities and entity cards.

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

JSON representation 
{
  "entities": [
    {
      object (ApiSecurityEntityDataModel)
    }
  ],
  "entityCards": [
    {
      object (SecurityEntityCard)
    }
  ]
}
Fields
entities[]

object (ApiSecurityEntityDataModel)

Optional. Entities is a list of entities.
entityCards[]

object (SecurityEntityCard)

Optional. EntityCards is a list of entity cards.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

SecurityEntityCard

SecurityEntityCard represents a security entity card.

JSON representation 
{
  "identifier": string,
  "entityType": string,
  "linkedEntities": [
    {
      object (SecurityEntityCard)
    }
  ],
  "isSuspicious": boolean,
  "direction": enum (SecurityEntityDirectionEnum)
}
Fields
identifier

string

Required. Identifier is the unique identifier of the entity.
entityType

string

Required. EntityType is the type of the entity.
linkedEntities[]

object (SecurityEntityCard)

Optional. LinkedEntities is a list of linked entities.
isSuspicious

boolean

Optional. IsSuspicious indicates if the entity is suspicious.
direction

enum (SecurityEntityDirectionEnum)

Optional. Direction is the direction of the entity.

SecurityEntityDirectionEnum

SecurityEntityDirectionEnum represents the direction of a security entity.

Enums
NONE The direction is unspecified.
INBOUND The direction is inbound.
OUTBOUND The direction is outbound.
BOTH The direction is both.