REST Resource: organizations.locations.eventThreatDetectionCustomModules

Resource: EventThreatDetectionCustomModule

A Security Command Center resource that contains the configuration and enablement state of a custom module, which enables Event Threat Detection to write certain findings to Security Command Center.

JSON representation 
{
  "name": string,
  "config": {
    object
  },
  "ancestorModule": string,
  "enablementState": enum (EnablementState),
  "type": string,
  "displayName": string,
  "description": string,
  "updateTime": string,
  "lastEditor": string
}
Fields
name

string

Identifier. The resource name of the Event Threat Detection custom module, in one of the following formats:

  • organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}
  • projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}
config

object (Struct format)

Optional. Configuration for the module. For the resident module, its configuration value is defined at this level. For the inherited module, its configuration value is inherited from the ancestor module.
ancestorModule

string

Output only. The closest ancestor module that this module inherits the enablement state from. If empty, indicates that the custom module was created in the requesting parent organization, folder, or project. The format is the same as the custom module's resource name.
enablementState

enum (EnablementState)

Optional. The state of enablement for the module at the given level of the hierarchy.
type

string

Optional. Type for the module. For example, CONFIGURABLE_BAD_IP.
displayName

string

Optional. The human-readable name of the module.
description

string

Optional. A description of the module.
updateTime

string (Timestamp format)

Output only. The time the module was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastEditor

string

Output only. The editor the module was last updated by.

Methods

create

 Creates a resident Event Threat Detection custom module at the scope of the given organization, folder, or project, and creates inherited custom modules for all descendants of the given parent.

delete

 Deletes the specified Event Threat Detection custom module and all of its descendants in the resource hierarchy.

get

 Gets an Event Threat Detection custom module.

list

 Lists all Event Threat Detection custom modules for the given organization, folder, or project.

listDescendant

 Lists all resident Event Threat Detection custom modules for the given organization, folder, or project and its descendants.

patch

 Updates the Event Threat Detection custom module with the given name based on the given update mask.

validate

 Validates the given Event Threat Detection custom module.