Method: folders.locations.securityHealthAnalyticsCustomModules.patch

Updates 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 configuration of a module is supported on resident modules only.

HTTP request

PATCH https://securitycentermanagement.googleapis.com/v1/{securityHealthAnalyticsCustomModule.name=folders/*/locations/*/securityHealthAnalyticsCustomModules/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
securityHealthAnalyticsCustomModule.name

string

Identifier. The full resource name of the custom module, in one of the following formats:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The fields to update. The following values are valid:

  • customConfig
  • enablementState

If you omit this field or set it to the wildcard value *, then all eligible fields are updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
validateOnly

boolean

Optional. When set to true, the request will be validated (including IAM checks), but no module will be updated. An OK response indicates that the request is valid, while an error response indicates that the request is invalid.

If the request is valid, a subsequent request to update the module could still fail for one of the following reasons:

  • The state of your cloud resources changed; for example, you lost a required IAM permission
  • An error occurred during creation of the module

Defaults to false.

Request body

The request body contains an instance of SecurityHealthAnalyticsCustomModule.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • securitycentermanagement.securityHealthAnalyticsCustomModules.update

For more information, see the IAM documentation.