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