REST Resource: folders.locations.securityHealthAnalyticsCustomModules

Resource: SecurityHealthAnalyticsCustomModule

Represents an instance of a Security Health Analytics custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization, folder, or project level. Custom modules that you create at the organization or folder level are inherited by the child folders and projects.

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

string

Immutable. The resource name of the custom module. Its format is "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}", or "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}", or "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}"

The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits.

displayName

string

Optional. The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only.

enablementState

enum (EnablementState)

Optional. The enablement state of the custom module.

updateTime

string (Timestamp format)

Output only. The time at which the custom 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 that last updated the custom module.

ancestorModule

string

Output only. Specifies the organization or folder from which the custom module is inherited. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module.

customConfig

object (CustomConfig)

Optional. The user specified custom configuration for the module.

EnablementState

Possible enablement states of a custom module.

Enums
ENABLEMENT_STATE_UNSPECIFIED Unspecified enablement state.
ENABLED The module is enabled at the given CRM resource.
DISABLED The module is disabled at the given CRM resource.
INHERITED State is inherited from an ancestor module. The module will either be effectively ENABLED or DISABLED based on its closest non-inherited ancestor module in the CRM hierarchy. Attempting to set a top level module (module with no parent) to the INHERITED state will result in an INVALID_ARGUMENT error.

Methods

create

Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent.

delete

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy.

get

Retrieves a SecurityHealthAnalyticsCustomModule.

list

Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent.

listDescendant

Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent's CRM descendants.

patch

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask.

simulate

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.