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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(bucket, entity, provisionalUserProject=None, userProject=None)</a></code></p> 82<p class="firstline">Permanently deletes the ACL entry for the specified entity on the specified bucket.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(bucket, entity, provisionalUserProject=None, userProject=None)</a></code></p> 85<p class="firstline">Returns the ACL entry for the specified entity on the specified bucket.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(bucket, body=None, provisionalUserProject=None, userProject=None)</a></code></p> 88<p class="firstline">Creates a new ACL entry on the specified bucket.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(bucket, provisionalUserProject=None, userProject=None)</a></code></p> 91<p class="firstline">Retrieves ACL entries on the specified bucket.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</a></code></p> 94<p class="firstline">Patches an ACL entry on the specified bucket.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</a></code></p> 97<p class="firstline">Updates an ACL entry on the specified bucket.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(bucket, entity, provisionalUserProject=None, userProject=None)</code> 106 <pre>Permanently deletes the ACL entry for the specified entity on the specified bucket. 107 108Args: 109 bucket: string, Name of a bucket. (required) 110 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 111 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 112 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 113</pre> 114</div> 115 116<div class="method"> 117 <code class="details" id="get">get(bucket, entity, provisionalUserProject=None, userProject=None)</code> 118 <pre>Returns the ACL entry for the specified entity on the specified bucket. 119 120Args: 121 bucket: string, Name of a bucket. (required) 122 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 123 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 124 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 125 126Returns: 127 An object of the form: 128 129 { # An access-control entry. 130 "bucket": "A String", # The name of the bucket. 131 "domain": "A String", # The domain associated with the entity, if any. 132 "email": "A String", # The email address associated with the entity, if any. 133 "entity": "A String", # The entity holding the permission, in one of the following forms: 134 # - user-userId 135 # - user-email 136 # - group-groupId 137 # - group-email 138 # - domain-domain 139 # - project-team-projectId 140 # - allUsers 141 # - allAuthenticatedUsers Examples: 142 # - The user liz@example.com would be user-liz@example.com. 143 # - The group example@googlegroups.com would be group-example@googlegroups.com. 144 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 145 "entityId": "A String", # The ID for the entity, if any. 146 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 147 "id": "A String", # The ID of the access-control entry. 148 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 149 "projectTeam": { # The project team associated with the entity, if any. 150 "projectNumber": "A String", # The project number. 151 "team": "A String", # The team. 152 }, 153 "role": "A String", # The access permission for the entity. 154 "selfLink": "A String", # The link to this access-control entry. 155}</pre> 156</div> 157 158<div class="method"> 159 <code class="details" id="insert">insert(bucket, body=None, provisionalUserProject=None, userProject=None)</code> 160 <pre>Creates a new ACL entry on the specified bucket. 161 162Args: 163 bucket: string, Name of a bucket. (required) 164 body: object, The request body. 165 The object takes the form of: 166 167{ # An access-control entry. 168 "bucket": "A String", # The name of the bucket. 169 "domain": "A String", # The domain associated with the entity, if any. 170 "email": "A String", # The email address associated with the entity, if any. 171 "entity": "A String", # The entity holding the permission, in one of the following forms: 172 # - user-userId 173 # - user-email 174 # - group-groupId 175 # - group-email 176 # - domain-domain 177 # - project-team-projectId 178 # - allUsers 179 # - allAuthenticatedUsers Examples: 180 # - The user liz@example.com would be user-liz@example.com. 181 # - The group example@googlegroups.com would be group-example@googlegroups.com. 182 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 183 "entityId": "A String", # The ID for the entity, if any. 184 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 185 "id": "A String", # The ID of the access-control entry. 186 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 187 "projectTeam": { # The project team associated with the entity, if any. 188 "projectNumber": "A String", # The project number. 189 "team": "A String", # The team. 190 }, 191 "role": "A String", # The access permission for the entity. 192 "selfLink": "A String", # The link to this access-control entry. 193} 194 195 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 196 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 197 198Returns: 199 An object of the form: 200 201 { # An access-control entry. 202 "bucket": "A String", # The name of the bucket. 203 "domain": "A String", # The domain associated with the entity, if any. 204 "email": "A String", # The email address associated with the entity, if any. 205 "entity": "A String", # The entity holding the permission, in one of the following forms: 206 # - user-userId 207 # - user-email 208 # - group-groupId 209 # - group-email 210 # - domain-domain 211 # - project-team-projectId 212 # - allUsers 213 # - allAuthenticatedUsers Examples: 214 # - The user liz@example.com would be user-liz@example.com. 215 # - The group example@googlegroups.com would be group-example@googlegroups.com. 216 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 217 "entityId": "A String", # The ID for the entity, if any. 218 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 219 "id": "A String", # The ID of the access-control entry. 220 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 221 "projectTeam": { # The project team associated with the entity, if any. 222 "projectNumber": "A String", # The project number. 223 "team": "A String", # The team. 224 }, 225 "role": "A String", # The access permission for the entity. 226 "selfLink": "A String", # The link to this access-control entry. 227}</pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="list">list(bucket, provisionalUserProject=None, userProject=None)</code> 232 <pre>Retrieves ACL entries on the specified bucket. 233 234Args: 235 bucket: string, Name of a bucket. (required) 236 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 237 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 238 239Returns: 240 An object of the form: 241 242 { # An access-control list. 243 "items": [ # The list of items. 244 { # An access-control entry. 245 "bucket": "A String", # The name of the bucket. 246 "domain": "A String", # The domain associated with the entity, if any. 247 "email": "A String", # The email address associated with the entity, if any. 248 "entity": "A String", # The entity holding the permission, in one of the following forms: 249 # - user-userId 250 # - user-email 251 # - group-groupId 252 # - group-email 253 # - domain-domain 254 # - project-team-projectId 255 # - allUsers 256 # - allAuthenticatedUsers Examples: 257 # - The user liz@example.com would be user-liz@example.com. 258 # - The group example@googlegroups.com would be group-example@googlegroups.com. 259 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 260 "entityId": "A String", # The ID for the entity, if any. 261 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 262 "id": "A String", # The ID of the access-control entry. 263 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 264 "projectTeam": { # The project team associated with the entity, if any. 265 "projectNumber": "A String", # The project number. 266 "team": "A String", # The team. 267 }, 268 "role": "A String", # The access permission for the entity. 269 "selfLink": "A String", # The link to this access-control entry. 270 }, 271 ], 272 "kind": "storage#bucketAccessControls", # The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls. 273}</pre> 274</div> 275 276<div class="method"> 277 <code class="details" id="patch">patch(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</code> 278 <pre>Patches an ACL entry on the specified bucket. 279 280Args: 281 bucket: string, Name of a bucket. (required) 282 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 283 body: object, The request body. 284 The object takes the form of: 285 286{ # An access-control entry. 287 "bucket": "A String", # The name of the bucket. 288 "domain": "A String", # The domain associated with the entity, if any. 289 "email": "A String", # The email address associated with the entity, if any. 290 "entity": "A String", # The entity holding the permission, in one of the following forms: 291 # - user-userId 292 # - user-email 293 # - group-groupId 294 # - group-email 295 # - domain-domain 296 # - project-team-projectId 297 # - allUsers 298 # - allAuthenticatedUsers Examples: 299 # - The user liz@example.com would be user-liz@example.com. 300 # - The group example@googlegroups.com would be group-example@googlegroups.com. 301 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 302 "entityId": "A String", # The ID for the entity, if any. 303 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 304 "id": "A String", # The ID of the access-control entry. 305 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 306 "projectTeam": { # The project team associated with the entity, if any. 307 "projectNumber": "A String", # The project number. 308 "team": "A String", # The team. 309 }, 310 "role": "A String", # The access permission for the entity. 311 "selfLink": "A String", # The link to this access-control entry. 312} 313 314 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 315 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 316 317Returns: 318 An object of the form: 319 320 { # An access-control entry. 321 "bucket": "A String", # The name of the bucket. 322 "domain": "A String", # The domain associated with the entity, if any. 323 "email": "A String", # The email address associated with the entity, if any. 324 "entity": "A String", # The entity holding the permission, in one of the following forms: 325 # - user-userId 326 # - user-email 327 # - group-groupId 328 # - group-email 329 # - domain-domain 330 # - project-team-projectId 331 # - allUsers 332 # - allAuthenticatedUsers Examples: 333 # - The user liz@example.com would be user-liz@example.com. 334 # - The group example@googlegroups.com would be group-example@googlegroups.com. 335 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 336 "entityId": "A String", # The ID for the entity, if any. 337 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 338 "id": "A String", # The ID of the access-control entry. 339 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 340 "projectTeam": { # The project team associated with the entity, if any. 341 "projectNumber": "A String", # The project number. 342 "team": "A String", # The team. 343 }, 344 "role": "A String", # The access permission for the entity. 345 "selfLink": "A String", # The link to this access-control entry. 346}</pre> 347</div> 348 349<div class="method"> 350 <code class="details" id="update">update(bucket, entity, body=None, provisionalUserProject=None, userProject=None)</code> 351 <pre>Updates an ACL entry on the specified bucket. 352 353Args: 354 bucket: string, Name of a bucket. (required) 355 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 356 body: object, The request body. 357 The object takes the form of: 358 359{ # An access-control entry. 360 "bucket": "A String", # The name of the bucket. 361 "domain": "A String", # The domain associated with the entity, if any. 362 "email": "A String", # The email address associated with the entity, if any. 363 "entity": "A String", # The entity holding the permission, in one of the following forms: 364 # - user-userId 365 # - user-email 366 # - group-groupId 367 # - group-email 368 # - domain-domain 369 # - project-team-projectId 370 # - allUsers 371 # - allAuthenticatedUsers Examples: 372 # - The user liz@example.com would be user-liz@example.com. 373 # - The group example@googlegroups.com would be group-example@googlegroups.com. 374 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 375 "entityId": "A String", # The ID for the entity, if any. 376 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 377 "id": "A String", # The ID of the access-control entry. 378 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 379 "projectTeam": { # The project team associated with the entity, if any. 380 "projectNumber": "A String", # The project number. 381 "team": "A String", # The team. 382 }, 383 "role": "A String", # The access permission for the entity. 384 "selfLink": "A String", # The link to this access-control entry. 385} 386 387 provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket. 388 userProject: string, The project to be billed for this request. Required for Requester Pays buckets. 389 390Returns: 391 An object of the form: 392 393 { # An access-control entry. 394 "bucket": "A String", # The name of the bucket. 395 "domain": "A String", # The domain associated with the entity, if any. 396 "email": "A String", # The email address associated with the entity, if any. 397 "entity": "A String", # The entity holding the permission, in one of the following forms: 398 # - user-userId 399 # - user-email 400 # - group-groupId 401 # - group-email 402 # - domain-domain 403 # - project-team-projectId 404 # - allUsers 405 # - allAuthenticatedUsers Examples: 406 # - The user liz@example.com would be user-liz@example.com. 407 # - The group example@googlegroups.com would be group-example@googlegroups.com. 408 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 409 "entityId": "A String", # The ID for the entity, if any. 410 "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry. 411 "id": "A String", # The ID of the access-control entry. 412 "kind": "storage#bucketAccessControl", # The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. 413 "projectTeam": { # The project team associated with the entity, if any. 414 "projectNumber": "A String", # The project number. 415 "team": "A String", # The team. 416 }, 417 "role": "A String", # The access permission for the entity. 418 "selfLink": "A String", # The link to this access-control entry. 419}</pre> 420</div> 421 422</body></html>