Method: projects.getSecurityHealthAnalyticsSettings

Get the SecurityHealthAnalyticsSettings resource.

In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, projects.getSecurityHealthAnalyticsSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use securityHealthAnalyticsSettings.calculate for this purpose.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the SecurityHealthAnalyticsSettings to retrieve.

Formats:

  • organizations/{organization}/securityHealthAnalyticsSettings
  • folders/{folder}/securityHealthAnalyticsSettings
  • projects/{project}/securityHealthAnalyticsSettings

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of SecurityHealthAnalyticsSettings.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.