# REST Resource: folders.locations.effectiveSecurityHealthAnalyticsCustomModules

- [Resource: EffectiveSecurityHealthAnalyticsCustomModule](https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#EffectiveSecurityHealthAnalyticsCustomModule)
  - [JSON representation](https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#EffectiveSecurityHealthAnalyticsCustomModule.SCHEMA_REPRESENTATION)
  - [EnablementState](https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#EffectiveSecurityHealthAnalyticsCustomModule.EnablementState)
- [Methods](https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#METHODS_SUMMARY)

## Resource: EffectiveSecurityHealthAnalyticsCustomModule

The representation of a Security Health Analytics custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from an ancestor organization or folder, then the enablement state is set to the value that is effective in the parent, not to `INHERITED`. For example, if the module is enabled in an organization or folder, then the effective enablement state for the module is `ENABLED` in all descendant folders or projects.

| JSON representation |
|---|
| ``` { "name": string, "customConfig": { object (`https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/CustomConfig`) }, "enablementState": enum (`https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#EffectiveSecurityHealthAnalyticsCustomModule.EnablementState`), "displayName": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The full resource name of the custom module, in one of the following formats: - `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` - `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` - `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}` |
| `customConfig` | ``object (`https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/CustomConfig`)`` Output only. The user-specified configuration for the module. |
| `enablementState` | ``enum (`https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#EffectiveSecurityHealthAnalyticsCustomModule.EnablementState`)`` Output only. The effective enablement state for the module at the given level of the hierarchy. |
| `displayName` | `string` Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. |

### EnablementState

The enablement state of the module.

| Enums ||
|---|---|
| `ENABLEMENT_STATE_UNSPECIFIED` | Default value. This value is unused. |
| `ENABLED` | The module is enabled at the given level. |
| `DISABLED` | The module is disabled at the given level. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules/get` | Gets details of a single `https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#EffectiveSecurityHealthAnalyticsCustomModule`. |
| ### `https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules/list` | Returns a list of all `https://docs.cloud.google.com/security-command-center/docs/reference/security-center-management/rest/v1/folders.locations.effectiveSecurityHealthAnalyticsCustomModules#EffectiveSecurityHealthAnalyticsCustomModule` resources for the given parent. |