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