- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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 config of a module is supported on resident modules only.
HTTP request
PATCH https://securitycentermanagement.googleapis.com/v1/{securityHealthAnalyticsCustomModule.name=organizations/*/locations/*/securityHealthAnalyticsCustomModules/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
securityHealthAnalyticsCustomModule.name |
Identifier. The resource name of the custom module. Its format is "organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}", or "folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}", or "projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{securityHealthAnalyticsCustomModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. |
Query parameters
Parameters | |
---|---|
updateMask |
Required. The list of fields to be updated. The only fields that can be updated are This is a comma-separated list of fully qualified names of fields. Example: |
validateOnly |
Optional. When set to true, only validations (including IAM checks) will done for the request (module will not be updated). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually update 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 update the module. |
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.