BucketAccessControls

The BucketAccessControls resource represents the Access Control Lists (ACLs) for buckets within Cloud Storage. ACLs let you specify who has access to your data and to what extent.Important: The methods for this resource fail with a400 Bad Request response for buckets with uniform bucket-level access enabled. Usestorage.buckets.getIamPolicy andstorage.buckets.setIamPolicy to control access instead. There are three roles that can be assigned to an entity:

  • READERs canget the bucket, though noacl property will be returned, andlist the bucket's objects.
  • WRITERs areREADERs, and they caninsert objects into the bucket anddelete the bucket's objects.
  • OWNERs areWRITERs, and they can get theacl property of abucket,update a bucket, and call all BucketAccessControls methods on the bucket.
For more information, seeAccess Control, with the caveat that this API usesREADER,WRITER, andOWNER instead ofREAD,WRITE, andFULL_CONTROL.

To try out the methods for this resource, seeMethods.

Resource representations

{  "kind": "storage#bucketAccessControl",  "id":string,  "selfLink":string,  "bucket":string,  "entity":string,  "role":string,  "email":string,  "domain":string,  "entityId":string,  "etag":string,  "projectTeam": {    "projectNumber":string,    "team":string  }}
Property nameValueDescriptionNotes
bucketstringThe name of the bucket.
domainstringThe domain associated with the entity, if any.
emailstringThe email address associated with the entity, if any.
entitystringThe entity holding the permission, in one of the following forms:
  • user-email
  • group-groupId
  • group-email
  • domain-domain
  • project-team-projectId
  • allUsers
  • allAuthenticatedUsers
Examples:
  • The userliz@example.com would beuser-liz@example.com.
  • The groupexample@googlegroups.com would begroup-example@googlegroups.com.
  • To refer to all members of the domainexample.com, the entity would bedomain-example.com.
 writable
entityIdstringThe ID for the entity, if any.
etagstringHTTP 1.1Entity tag for the access-control entry.
idstringThe ID of the access-control entry.
kindstringThe kind of item this is. For bucket access control entries, this is alwaysstorage#bucketAccessControl.
projectTeamobjectThe project team associated with the entity, if any.
projectTeam.projectNumberstringThe project number.
projectTeam.teamstringThe team.

Acceptable values are:
  • "editors"
  • "owners"
  • "viewers"
rolestringThe access permission for the entity.

Acceptable values are:
  • "OWNER"
  • "READER"
  • "WRITER"
 writable
selfLinkstringThe link to this access-control entry.

Methods

The methods for working with a bucket's access controls are as follows:

delete
Permanently deletes the ACL entry for the specified entity on the specifiedbucket.
get
Returns the ACL entry for the specified entity on the specified bucket.
insert
Creates a new ACL entry on the specifiedbucket.
list
Retrieves ACL entries on a specifiedbucket.
patch
Updates an ACL entry on the specifiedbucket. This method supportspatch semantics.
update
Updates an ACL entry on the specifiedbucket.

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-12-17 UTC.