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_v1beta1.html">Cloud Storage JSON API</a> . <a href="storage_v1beta1.objectAccessControls.html">objectAccessControls</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(bucket, object, entity)</a></code></p> 79 <p class="firstline">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)</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)</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)</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)</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)</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)</code> 98 <pre>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. (required) 103 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 104 </pre> 105 </div> 106 107 <div class="method"> 108 <code class="details" id="get">get(bucket, object, entity)</code> 109 <pre>Returns the ACL entry for the specified entity on the specified object. 110 111 Args: 112 bucket: string, Name of a bucket. (required) 113 object: string, Name of the object. (required) 114 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 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 "object": "A String", # The name of the object. 122 "bucket": "A String", # The name of the bucket. 123 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 124 "id": "A String", # The ID of the access-control entry. 125 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 126 "entityId": "A String", # The ID for the entity, if any. 127 "entity": "A String", # The entity holding the permission, in one of the following forms: 128 # - user-userId 129 # - user-email 130 # - group-groupId 131 # - group-email 132 # - domain-domain 133 # - allUsers 134 # - allAuthenticatedUsers Examples: 135 # - The user liz (a] example.com would be user-liz (a] example.com. 136 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 137 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 138 "email": "A String", # The email address associated with the entity, if any. 139 "selfLink": "A String", # The link to this access-control entry. 140 }</pre> 141 </div> 142 143 <div class="method"> 144 <code class="details" id="insert">insert(bucket, object, body)</code> 145 <pre>Creates a new ACL entry on the specified object. 146 147 Args: 148 bucket: string, Name of a bucket. (required) 149 object: string, Name of the object. (required) 150 body: object, The request body. (required) 151 The object takes the form of: 152 153 { # An access-control entry. 154 "domain": "A String", # The domain associated with the entity, if any. 155 "object": "A String", # The name of the object. 156 "bucket": "A String", # The name of the bucket. 157 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 158 "id": "A String", # The ID of the access-control entry. 159 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 160 "entityId": "A String", # The ID for the entity, if any. 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 # - allUsers 168 # - allAuthenticatedUsers Examples: 169 # - The user liz (a] example.com would be user-liz (a] example.com. 170 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 171 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 172 "email": "A String", # The email address associated with the entity, if any. 173 "selfLink": "A String", # The link to this access-control entry. 174 } 175 176 177 Returns: 178 An object of the form: 179 180 { # An access-control entry. 181 "domain": "A String", # The domain associated with the entity, if any. 182 "object": "A String", # The name of the object. 183 "bucket": "A String", # The name of the bucket. 184 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 185 "id": "A String", # The ID of the access-control entry. 186 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 187 "entityId": "A String", # The ID for the entity, if any. 188 "entity": "A String", # The entity holding the permission, in one of the following forms: 189 # - user-userId 190 # - user-email 191 # - group-groupId 192 # - group-email 193 # - domain-domain 194 # - allUsers 195 # - allAuthenticatedUsers Examples: 196 # - The user liz (a] example.com would be user-liz (a] example.com. 197 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 198 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 199 "email": "A String", # The email address associated with the entity, if any. 200 "selfLink": "A String", # The link to this access-control entry. 201 }</pre> 202 </div> 203 204 <div class="method"> 205 <code class="details" id="list">list(bucket, object)</code> 206 <pre>Retrieves ACL entries on the specified object. 207 208 Args: 209 bucket: string, Name of a bucket. (required) 210 object: string, Name of the object. (required) 211 212 Returns: 213 An object of the form: 214 215 { # An access-control list. 216 "items": [ # The list of items. 217 { # An access-control entry. 218 "domain": "A String", # The domain associated with the entity, if any. 219 "object": "A String", # The name of the object. 220 "bucket": "A String", # The name of the bucket. 221 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 222 "id": "A String", # The ID of the access-control entry. 223 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 224 "entityId": "A String", # The ID for the entity, if any. 225 "entity": "A String", # The entity holding the permission, in one of the following forms: 226 # - user-userId 227 # - user-email 228 # - group-groupId 229 # - group-email 230 # - domain-domain 231 # - allUsers 232 # - allAuthenticatedUsers Examples: 233 # - The user liz (a] example.com would be user-liz (a] example.com. 234 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 235 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 236 "email": "A String", # The email address associated with the entity, if any. 237 "selfLink": "A String", # The link to this access-control entry. 238 }, 239 ], 240 "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls. 241 }</pre> 242 </div> 243 244 <div class="method"> 245 <code class="details" id="patch">patch(bucket, object, entity, body)</code> 246 <pre>Updates an ACL entry on the specified object. This method supports patch semantics. 247 248 Args: 249 bucket: string, Name of a bucket. (required) 250 object: string, Name of the object. (required) 251 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 252 body: object, The request body. (required) 253 The object takes the form of: 254 255 { # An access-control entry. 256 "domain": "A String", # The domain associated with the entity, if any. 257 "object": "A String", # The name of the object. 258 "bucket": "A String", # The name of the bucket. 259 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 260 "id": "A String", # The ID of the access-control entry. 261 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 262 "entityId": "A String", # The ID for the entity, if any. 263 "entity": "A String", # The entity holding the permission, in one of the following forms: 264 # - user-userId 265 # - user-email 266 # - group-groupId 267 # - group-email 268 # - domain-domain 269 # - allUsers 270 # - allAuthenticatedUsers Examples: 271 # - The user liz (a] example.com would be user-liz (a] example.com. 272 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 273 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 274 "email": "A String", # The email address associated with the entity, if any. 275 "selfLink": "A String", # The link to this access-control entry. 276 } 277 278 279 Returns: 280 An object of the form: 281 282 { # An access-control entry. 283 "domain": "A String", # The domain associated with the entity, if any. 284 "object": "A String", # The name of the object. 285 "bucket": "A String", # The name of the bucket. 286 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 287 "id": "A String", # The ID of the access-control entry. 288 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 289 "entityId": "A String", # The ID for 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 # - allUsers 297 # - allAuthenticatedUsers Examples: 298 # - The user liz (a] example.com would be user-liz (a] example.com. 299 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 300 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 301 "email": "A String", # The email address associated with the entity, if any. 302 "selfLink": "A String", # The link to this access-control entry. 303 }</pre> 304 </div> 305 306 <div class="method"> 307 <code class="details" id="update">update(bucket, object, entity, body)</code> 308 <pre>Updates an ACL entry on the specified object. 309 310 Args: 311 bucket: string, Name of a bucket. (required) 312 object: string, Name of the object. (required) 313 entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required) 314 body: object, The request body. (required) 315 The object takes the form of: 316 317 { # An access-control entry. 318 "domain": "A String", # The domain associated with the entity, if any. 319 "object": "A String", # The name of the object. 320 "bucket": "A String", # The name of the bucket. 321 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 322 "id": "A String", # The ID of the access-control entry. 323 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 324 "entityId": "A String", # The ID for the entity, if any. 325 "entity": "A String", # The entity holding the permission, in one of the following forms: 326 # - user-userId 327 # - user-email 328 # - group-groupId 329 # - group-email 330 # - domain-domain 331 # - allUsers 332 # - allAuthenticatedUsers Examples: 333 # - The user liz (a] example.com would be user-liz (a] example.com. 334 # - The group example (a] googlegroups.com would be group-example (a] 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 "email": "A String", # The email address associated with the entity, if any. 337 "selfLink": "A String", # The link to this access-control entry. 338 } 339 340 341 Returns: 342 An object of the form: 343 344 { # An access-control entry. 345 "domain": "A String", # The domain associated with the entity, if any. 346 "object": "A String", # The name of the object. 347 "bucket": "A String", # The name of the bucket. 348 "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl. 349 "id": "A String", # The ID of the access-control entry. 350 "role": "A String", # The access permission for the entity. Can be READER or OWNER. 351 "entityId": "A String", # The ID for the entity, if any. 352 "entity": "A String", # The entity holding the permission, in one of the following forms: 353 # - user-userId 354 # - user-email 355 # - group-groupId 356 # - group-email 357 # - domain-domain 358 # - allUsers 359 # - allAuthenticatedUsers Examples: 360 # - The user liz (a] example.com would be user-liz (a] example.com. 361 # - The group example (a] googlegroups.com would be group-example (a] googlegroups.com. 362 # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. 363 "email": "A String", # The email address associated with the entity, if any. 364 "selfLink": "A String", # The link to this access-control entry. 365 }</pre> 366 </div> 367 368 </body></html>
