1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.bucketAccessControls.html">bucketAccessControls</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(bucket, entity, userProject=None, provisionalUserProject=None)</a></code></p> 79<p class="firstline">Permanently deletes the ACL entry for the specified entity on the specified bucket.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(bucket, entity, userProject=None, provisionalUserProject=None)</a></code></p> 82<p class="firstline">Returns the ACL entry for the specified entity on the specified bucket.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(bucket, body, userProject=None, provisionalUserProject=None)</a></code></p> 85<p class="firstline">Creates a new ACL entry on the specified bucket.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(bucket, userProject=None, provisionalUserProject=None)</a></code></p> 88<p class="firstline">Retrieves ACL entries on the specified bucket.</p> 89<p class="toc_element"> 90 <code><a href="#patch">patch(bucket, entity, body, userProject=None, provisionalUserProject=None)</a></code></p> 91<p class="firstline">Patches an ACL entry on the specified bucket.</p> 92<p class="toc_element"> 93 <code><a href="#update">update(bucket, entity, body, userProject=None, provisionalUserProject=None)</a></code></p> 94<p class="firstline">Updates an ACL entry on the specified bucket.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="delete">delete(bucket, entity, userProject=None, provisionalUserProject=None)</code> 98 <pre>Permanently deletes the ACL entry for the specified entity on the specified bucket. 99 100Args: 101 bucket: string, Name of a bucket. (required) 102 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 103 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 104 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 105</pre> 106</div> 107 108<div class="method"> 109 <code class="details" id="get">get(bucket, entity, userProject=None, provisionalUserProject=None)</code> 110 <pre>Returns the ACL entry for the specified entity on the specified bucket. 111 112Args: 113 bucket: string, Name of a bucket. (required) 114 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 115 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 116 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 117 118Returns: 119 An object of the form: 120 121 { # An access-control entry. 122 "domain": "A String", # The domain associated with the entity, if any. 123 "bucket": "A String", # The name of the bucket. 124 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 125 "entity": "A String", # The entity holding the permission, in one of the following forms: 126 # - user-userId 127 # - user-email 128 # - group-groupId 129 # - group-email 130 # - domain-domain 131 # - project-team-projectId 132 # - allUsers 133 # - allAuthenticatedUsers Examples: 134 # - The user liz@example.com would be user-liz@example.com. 135 # - The group example@googlegroups.com would be group-example@googlegroups.com. 136 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 137 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 138 "role": "A String", # The access permission for the entity. 139 "id": "A String", # The ID of the access-control entry. 140 "entityId": "A String", # The ID for the entity, if any. 141 "projectTeam": { # The project team associated with the entity, if any. 142 "projectNumber": "A String", # The project number. 143 "team": "A String", # The team. 144 }, 145 "email": "A String", # The email address associated with the entity, if any. 146 "selfLink": "A String", # The link to this access-control entry. 147 }</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="insert">insert(bucket, body, userProject=None, provisionalUserProject=None)</code> 152 <pre>Creates a new ACL entry on the specified bucket. 153 154Args: 155 bucket: string, Name of a bucket. (required) 156 body: object, The request body. (required) 157 The object takes the form of: 158 159{ # An access-control entry. 160 "domain": "A String", # The domain associated with the entity, if any. 161 "bucket": "A String", # The name of the bucket. 162 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 163 "entity": "A String", # The entity holding the permission, in one of the following forms: 164 # - user-userId 165 # - user-email 166 # - group-groupId 167 # - group-email 168 # - domain-domain 169 # - project-team-projectId 170 # - allUsers 171 # - allAuthenticatedUsers Examples: 172 # - The user liz@example.com would be user-liz@example.com. 173 # - The group example@googlegroups.com would be group-example@googlegroups.com. 174 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 175 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 176 "role": "A String", # The access permission for the entity. 177 "id": "A String", # The ID of the access-control entry. 178 "entityId": "A String", # The ID for the entity, if any. 179 "projectTeam": { # The project team associated with the entity, if any. 180 "projectNumber": "A String", # The project number. 181 "team": "A String", # The team. 182 }, 183 "email": "A String", # The email address associated with the entity, if any. 184 "selfLink": "A String", # The link to this access-control entry. 185 } 186 187 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 188 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 189 190Returns: 191 An object of the form: 192 193 { # An access-control entry. 194 "domain": "A String", # The domain associated with the entity, if any. 195 "bucket": "A String", # The name of the bucket. 196 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 197 "entity": "A String", # The entity holding the permission, in one of the following forms: 198 # - user-userId 199 # - user-email 200 # - group-groupId 201 # - group-email 202 # - domain-domain 203 # - project-team-projectId 204 # - allUsers 205 # - allAuthenticatedUsers Examples: 206 # - The user liz@example.com would be user-liz@example.com. 207 # - The group example@googlegroups.com would be group-example@googlegroups.com. 208 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 209 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 210 "role": "A String", # The access permission for the entity. 211 "id": "A String", # The ID of the access-control entry. 212 "entityId": "A String", # The ID for the entity, if any. 213 "projectTeam": { # The project team associated with the entity, if any. 214 "projectNumber": "A String", # The project number. 215 "team": "A String", # The team. 216 }, 217 "email": "A String", # The email address associated with the entity, if any. 218 "selfLink": "A String", # The link to this access-control entry. 219 }</pre> 220</div> 221 222<div class="method"> 223 <code class="details" id="list">list(bucket, userProject=None, provisionalUserProject=None)</code> 224 <pre>Retrieves ACL entries on the specified bucket. 225 226Args: 227 bucket: string, Name of a bucket. (required) 228 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 229 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 230 231Returns: 232 An object of the form: 233 234 { # An access-control list. 235 "items": [ # The list of items. 236 { # An access-control entry. 237 "domain": "A String", # The domain associated with the entity, if any. 238 "bucket": "A String", # The name of the bucket. 239 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 240 "entity": "A String", # The entity holding the permission, in one of the following forms: 241 # - user-userId 242 # - user-email 243 # - group-groupId 244 # - group-email 245 # - domain-domain 246 # - project-team-projectId 247 # - allUsers 248 # - allAuthenticatedUsers Examples: 249 # - The user liz@example.com would be user-liz@example.com. 250 # - The group example@googlegroups.com would be group-example@googlegroups.com. 251 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 252 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 253 "role": "A String", # The access permission for the entity. 254 "id": "A String", # The ID of the access-control entry. 255 "entityId": "A String", # The ID for the entity, if any. 256 "projectTeam": { # The project team associated with the entity, if any. 257 "projectNumber": "A String", # The project number. 258 "team": "A String", # The team. 259 }, 260 "email": "A String", # The email address associated with the entity, if any. 261 "selfLink": "A String", # The link to this access-control entry. 262 }, 263 ], 264 "kind": "storage#bucketAccessControls", # The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. 265 }</pre> 266</div> 267 268<div class="method"> 269 <code class="details" id="patch">patch(bucket, entity, body, userProject=None, provisionalUserProject=None)</code> 270 <pre>Patches an ACL entry on the specified bucket. 271 272Args: 273 bucket: string, Name of a bucket. (required) 274 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 275 body: object, The request body. (required) 276 The object takes the form of: 277 278{ # An access-control entry. 279 "domain": "A String", # The domain associated with the entity, if any. 280 "bucket": "A String", # The name of the bucket. 281 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 282 "entity": "A String", # The entity holding the permission, in one of the following forms: 283 # - user-userId 284 # - user-email 285 # - group-groupId 286 # - group-email 287 # - domain-domain 288 # - project-team-projectId 289 # - allUsers 290 # - allAuthenticatedUsers Examples: 291 # - The user liz@example.com would be user-liz@example.com. 292 # - The group example@googlegroups.com would be group-example@googlegroups.com. 293 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 294 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 295 "role": "A String", # The access permission for the entity. 296 "id": "A String", # The ID of the access-control entry. 297 "entityId": "A String", # The ID for the entity, if any. 298 "projectTeam": { # The project team associated with the entity, if any. 299 "projectNumber": "A String", # The project number. 300 "team": "A String", # The team. 301 }, 302 "email": "A String", # The email address associated with the entity, if any. 303 "selfLink": "A String", # The link to this access-control entry. 304 } 305 306 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 307 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 308 309Returns: 310 An object of the form: 311 312 { # An access-control entry. 313 "domain": "A String", # The domain associated with the entity, if any. 314 "bucket": "A String", # The name of the bucket. 315 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 316 "entity": "A String", # The entity holding the permission, in one of the following forms: 317 # - user-userId 318 # - user-email 319 # - group-groupId 320 # - group-email 321 # - domain-domain 322 # - project-team-projectId 323 # - allUsers 324 # - allAuthenticatedUsers Examples: 325 # - The user liz@example.com would be user-liz@example.com. 326 # - The group example@googlegroups.com would be group-example@googlegroups.com. 327 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 328 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 329 "role": "A String", # The access permission for the entity. 330 "id": "A String", # The ID of the access-control entry. 331 "entityId": "A String", # The ID for the entity, if any. 332 "projectTeam": { # The project team associated with the entity, if any. 333 "projectNumber": "A String", # The project number. 334 "team": "A String", # The team. 335 }, 336 "email": "A String", # The email address associated with the entity, if any. 337 "selfLink": "A String", # The link to this access-control entry. 338 }</pre> 339</div> 340 341<div class="method"> 342 <code class="details" id="update">update(bucket, entity, body, userProject=None, provisionalUserProject=None)</code> 343 <pre>Updates an ACL entry on the specified bucket. 344 345Args: 346 bucket: string, Name of a bucket. (required) 347 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 348 body: object, The request body. (required) 349 The object takes the form of: 350 351{ # An access-control entry. 352 "domain": "A String", # The domain associated with the entity, if any. 353 "bucket": "A String", # The name of the bucket. 354 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 355 "entity": "A String", # The entity holding the permission, in one of the following forms: 356 # - user-userId 357 # - user-email 358 # - group-groupId 359 # - group-email 360 # - domain-domain 361 # - project-team-projectId 362 # - allUsers 363 # - allAuthenticatedUsers Examples: 364 # - The user liz@example.com would be user-liz@example.com. 365 # - The group example@googlegroups.com would be group-example@googlegroups.com. 366 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 367 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 368 "role": "A String", # The access permission for the entity. 369 "id": "A String", # The ID of the access-control entry. 370 "entityId": "A String", # The ID for the entity, if any. 371 "projectTeam": { # The project team associated with the entity, if any. 372 "projectNumber": "A String", # The project number. 373 "team": "A String", # The team. 374 }, 375 "email": "A String", # The email address associated with the entity, if any. 376 "selfLink": "A String", # The link to this access-control entry. 377 } 378 379 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 380 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 381 382Returns: 383 An object of the form: 384 385 { # An access-control entry. 386 "domain": "A String", # The domain associated with the entity, if any. 387 "bucket": "A String", # The name of the bucket. 388 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 389 "entity": "A String", # The entity holding the permission, in one of the following forms: 390 # - user-userId 391 # - user-email 392 # - group-groupId 393 # - group-email 394 # - domain-domain 395 # - project-team-projectId 396 # - allUsers 397 # - allAuthenticatedUsers Examples: 398 # - The user liz@example.com would be user-liz@example.com. 399 # - The group example@googlegroups.com would be group-example@googlegroups.com. 400 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 401 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 402 "role": "A String", # The access permission for the entity. 403 "id": "A String", # The ID of the access-control entry. 404 "entityId": "A String", # The ID for the entity, if any. 405 "projectTeam": { # The project team associated with the entity, if any. 406 "projectNumber": "A String", # The project number. 407 "team": "A String", # The team. 408 }, 409 "email": "A String", # The email address associated with the entity, if any. 410 "selfLink": "A String", # The link to this access-control entry. 411 }</pre> 412</div> 413 414</body></html>