Security Command Center API . projects . securityHealthAnalyticsSettings

Instance Methods

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)

Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

close()

Close httplib2 connections.

Method Details

calculate(name, showEligibleModulesOnly=None, x__xgafv=None)
Calculates the effective SecurityHealthAnalyticsSettings based on its level in the resource hierarchy and its settings. Settings provided closer to the target resource take precedence over those further away (e.g. folder will override organization level settings). The default SCC setting for the detector service defaults can be overridden at organization, folder and project levels. No assumptions should be made about the SCC defaults as it is considered an internal implementation detail.

Args:
  name: string, Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
  showEligibleModulesOnly: boolean, Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Resource capturing the settings for the Security Health Analytics service.
  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
    "a_key": { # Configuration of a module.
      "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
      "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
        "a_key": "", # Properties of the object.
      },
    },
  },
  "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings
  "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors.
  "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED.
  "updateTime": "A String", # Output only. The time the settings were last updated.
}
close()
Close httplib2 connections.