Method: organizations.locations.frameworks.patch

Updates a custom framework. This method allows for partial updates of a framework. 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 framework body are used to overwrite the existing resource.

You can only update frameworks with the CUSTOM type. A successful update creates a new version of the framework.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
framework.name

string

Required. Identifier. The name of the framework, in the format organizations/{organization}/locations/{location}/frameworks/{frameworkId}. The only supported location is global.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. A field mask is used to specify the fields to be overwritten in the framework resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't provide a mask then all fields present in the request will be overwritten.

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

string (int64 format)

Optional. The major version ID of the framework to update.

Request body

The request body contains an instance of Framework.

Response body

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

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.frameworks.update

For more information, see the IAM documentation.