Method: googleapis.storage.v1.objectAccessControls.patch

Note: You should URL-encode object names to be path safe. You can use theurl_encode andurl_encode_plusfunctions to encode applicable characters when they appear in either the objectname or query string of a request URL. If you don't url-encode your object nameand your storage bucket hasfolders, the request willfail. For more information, seeEncoding URL path parts andCloud Storage naming considerations.

Patches an ACL entry on the specified object.

Arguments

Parameters
bucket

string

Required. Name of a bucket.

entity

string

Required. The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

object

string

Required. Name of the object. For information about how to URL encode object names to be path safe, seeEncoding URI Path Parts.

generation

string (int64 format)

If present, selects a specific revision of this object (as opposed to the latest version, the default).

userProject

string

The project to be billed for this request. Required for Requester Pays buckets.

body

object (ObjectAccessControl)

Required.

Raised exceptions

Exceptions
ConnectionErrorIn case of a network problem (such as DNS failure or refused connection).
HttpErrorIf the response status is >= 400 (excluding 429 and 503).
TimeoutErrorIf a long-running operation takes longer to finish than the specified timeout limit.
TypeErrorIf an operation or function receives an argument of the wrong type.
ValueErrorIf an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance ofObjectAccessControl.

Subworkflow snippet

Some fields might be optional or required.To identify required fields, refer to theAPI documentation.

YAML

-patch:call:googleapis.storage.v1.objectAccessControls.patchargs:bucket:...entity:...object:...generation:...userProject:...body:bucket:...domain:...email:...entity:...entityId:...etag:...generation:...id:...kind:...object:...projectTeam:projectNumber:...team:...role:...selfLink:...result:patchResult

JSON

[{"patch":{"call":"googleapis.storage.v1.objectAccessControls.patch","args":{"bucket":"...","entity":"...","object":"...","generation":"...","userProject":"...","body":{"bucket":"...","domain":"...","email":"...","entity":"...","entityId":"...","etag":"...","generation":"...","id":"...","kind":"...","object":"...","projectTeam":{"projectNumber":"...","team":"..."},"role":"...","selfLink":"..."}},"result":"patchResult"}}]

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 2026-02-19 UTC.