Method: projects.locations.policyBindings.patch

Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update. Target and policy are immutable and cannot be updated.

HTTP request

PATCH https://iam.googleapis.com/v3beta/{policyBinding.name=projects/*/locations/*/policyBindings/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
policyBinding.name

string

Identifier. The name of the policy binding, in the format{binding_parent/locations/{location}/policyBindings/{policyBindingId}. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target.

Format:

  • projects/{projectId}/locations/{location}/policyBindings/{policyBindingId}
  • projects/{projectNumber}/locations/{location}/policyBindings/{policyBindingId}
  • folders/{folderId}/locations/{location}/policyBindings/{policyBindingId}
  • organizations/{organizationId}/locations/{location}/policyBindings/{policyBindingId}

Query parameters

Parameters
validateOnly

boolean

Optional. If set, validate the request and preview the update, but do not actually post it.

updateMask

string (FieldMask format)

Optional. The list of fields to update

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

Request body

The request body contains an instance ofPolicyBinding.

Response body

If successful, the response body contains an instance ofOperation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-26 UTC.