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