Method: folders.locations.securityHealthAnalyticsCustomModules.delete

Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the SHA custom module.

Its format is:

  • "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}".
  • "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}".
  • "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}".

Query parameters



Optional. When set to true, only validations (including IAM checks) will done for the request (module will not be deleted). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually delete the module could still fail because 1. the state could have changed (e.g. IAM permission lost) or 2. A failure occurred while trying to delete the module.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • securitycentermanagement.securityHealthAnalyticsCustomModules.delete

For more information, see the IAM documentation.