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