Method: organizations.locations.cloudControls.patch

Updates a custom cloud control. This method allows for partial updates of a cloud control. Use the updateMask to specify which fields to update. Consider the following:

  • If you provide an updateMask, only the fields that are specified in the mask are updated.
  • If you don't provide an updateMask, all the fields that are present in the request's cloudControl body are used to overwrite the existing resource.

You can only update cloud controls with the CUSTOM type. A successful update creates a new version of the cloud control.

HTTP request

PATCH https://cloudsecuritycompliance.googleapis.com/v1/{cloudControl.name=organizations/*/locations/*/cloudControls/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
cloudControl.name

string

Required. Identifier. The name of the cloud control, in the format organizations/{organization}/locations/{location}/cloudControls/{cloudControlId}. The only supported location is global.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Use a field mask to specify the fields to be overwritten in the cloud control during the update. The fields that you specify in the updateMask are relative to the cloud control, not the full request. A field is overwritten if it is in the mask. If you don't provide a mask, all fields in the request are updated.

You can update the following fields:

  • Display name
  • Description
  • Parameters
  • Rules
  • Parameter specification

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

Request body

The request body contains an instance of CloudControl.

Response body

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

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:

  • cloudsecuritycompliance.cloudControls.update

For more information, see the IAM documentation.