Skip to main content

custom_modules

Overview

Namecustom_modules
TypeResource
Idgoogle.securitycenter.custom_modules

Fields

NameDatatypeDescription
namestringImmutable. The resource name of the Event Threat Detection custom module. Its format is: "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
descriptionstringThe description for the module.
configobjectConfig for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
displayNamestringThe human readable name to be displayed for the module.
enablementStatestringThe state of enablement for the module at the given level of the hierarchy.
lastEditorstringOutput only. The editor the module was last updated by.
typestringType for the module. e.g. CONFIGURABLE_BAD_IP.
updateTimestringOutput only. The time the module was last updated.

Methods

NameAccessible byRequired ParamsDescription
organizations_event_threat_detection_settings_custom_modules_getSELECTcustomModulesId, organizationsIdGets an Event Threat Detection custom module.
folders_security_health_analytics_settings_custom_modules_patchEXECcustomModulesId, foldersIdUpdates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
organizations_event_threat_detection_settings_custom_modules_patchEXECcustomModulesId, organizationsIdUpdates an Event Threat Detection custom module.
organizations_security_health_analytics_settings_custom_modules_patchEXECcustomModulesId, organizationsIdUpdates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
projects_security_health_analytics_settings_custom_modules_patchEXECcustomModulesId, projectsIdUpdates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.