Method: organizations.locations.postureDeployments.patch

Updates an existing PostureDeployment.

To prevent concurrent updates from overwriting each other, always follow the read-modify-write pattern when you update a posture deployment:

  1. Call postureDeployments.get to get the current version of the deployment.
  2. Update the fields in the deployment as needed.
  3. Call postureDeployments.patch to update the deployment. Ensure that your request includes the etag value from the postureDeployments.get response.

Important: If you omit the etag when you call postureDeployments.patch, then the updated deployment unconditionally overwrites the existing deployment.

HTTP request

PATCH https://securityposture.googleapis.com/v1/{postureDeployment.name=organizations/*/locations/*/postureDeployments/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
postureDeployment.name

string

Required. The name of the posture deployment, in the format organizations/{organization}/locations/global/postureDeployments/{deployment_id}.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The fields in the PostureDeployment to update.

You can update only the following fields:

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 PostureDeployment.

Response body

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

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:

  • securityposture.postureDeployments.update

For more information, see the IAM documentation.