All Documents
Current Document

Content is empty

If you don't find the content you expect, please try another search term

Documentation

PUT Bucket ACL

Last updated:2021-09-14 16:18:03

Description

This PUT operation uses the 'ACL' resource to set access permissions for the existing user space through the access permission list.

Currently, only the bucket owner has this permission

You can use the following two ways to set object permissions.

  • Specify 'ACL' in the request body.
  • Use the request header to set access rights.

Note: The above two methods cannot be used at the same time.

Request

Grammar

The following shows how to set by specifying 'ACL' in the request body.

PUT /?acl HTTP/1.1
Host: {BucketName}.{endpoint}
Date: {date}
Authorization: {SignatureValue}

<AccessControlPolicy>
  <Owner>
    <ID>{ID}</ID>
    <DisplayName>{EmailAddress}</DisplayName>
  </Owner>
  <AccessControlList>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
        <ID>{ID}</ID>
        <DisplayName>{EmailAddress}</DisplayName>
      </Grantee>
      <Permission>{Permission}</Permission>
    </Grant>
    ...
  </AccessControlList>
</AccessControlPolicy>

Note:

Request parameters

The interface does not use request parameters.

Request header

The interface can use all common request headers. For more information, please click Public request headers. The user can set the preset ACL for bucket through the following headers.

Name Description Necessity
x-kss-acl Used to set predefined permissions for an object.
Type: String
Default value: private
Valid value: private &##124; public-read &##124; public-read-write
Constraints: None
No

If you want to set the detailed ACL for the bucket, you can use the following header settings

Name Description Necessity
x-kss-grant-read Grant READ permission to several users.
Type: String
Default: None
Constraints: None
No
x-kss-grant-write Grant WRITE permission to several users.
Type: String
Default: None
Constraints: None
No
x-kss-grant-full-control Grant FULL_CONTROL to several users.
Type: String
Default: None
Constraints: None
No

The value of the above header value is a comma separated authorization list. The format of each authorization information is type = value. The current type supports ID:

  • ID: user ID of the authorized person

For example, to grant WRITE permission to two users with ID 1234578 and 3344211: x-kss-grant-write:id="1234578",id="3344211"

Request content

If the user decides to use the request body to specify the access list, the following table element is required.

Note: If you use the request body to set ACL, you can no longer set ACL through the request header.

Name Description
AccessControlList Container containing 'Grant', 'Grantee', 'Permission'
Type: Container
Parent node: AccessControlPolicy
AccessControlPolicy Contains the ACL permission setting information of each 'Grantee' for an object
Type: Container
Parent node: None
Grant Contains information about authorized persons and their permissions.
Type: String
Parent node: AccessControlPolicy.AccessControlList
Grantee Authorized person, refer to the way of granting authority
Type: String
Parent node: AccessControlPolicy.AccessControlList.Grant
DisplayName Name of bucket owner
Type: String
Parent node: AccessControlPolicy.Owner
ID The user ID of the bucket owner or the ID of the authorized person
Type: String
Parent node: AccessControlPolicy.Owner or AccessControlPolicy.AccessControlList.Grant
Owner Container containing bucket owner information(DisplayName,ID
Type: Container
Parent node: AccessControlPolicy
Permission Indicates the permission information granted to the authorized person(FULL_CONTROL,READ,WRITE
Type: String
Parent node: AccessControlPolicy.AccessControlList.Grant

The way of granting permission

Users can grant a user permission to the user space in the following way.

Specific user rights are granted based on user ID

IDGranteesEmail

Response

Response header

This interface can use all common response headers. For more information, please click Public response headers.

Response content

The interface does not return the corresponding content.

Special errors

The interface does not return any special errors.

Example

Request example

PUT /?acl HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Content-Length: 1660
Date: Fri, 26 Dec 2014 06:34:32 GMT
Authorization: authorization string

<AccessControlPolicy xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Owner>
<ID>73410125</ID>
<DisplayName>ks3@kingsoft.com</DisplayName>
</Owner>
<AccessControlList>
<Grant>
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
<ID>73410125</ID>
<DisplayName>ks3@kingsoft.com</DisplayName>
</Grantee>
<Permission>FULL_CONTROL</Permission>
</Grant>
<Grant>
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
<ID>73410125</ID>
<DisplayName>ks3@kingsoft.com</DisplayName>
</Grantee>
<Permission>READ</Permission>
</Grant>
</AccessControlList>
</AccessControlPolicy>

Response example

HTTP/1.1 200 OK
Date: Fri, 26 Dec 2014 06:34:32 GMT
x-kss-request-id: dbea4ce4ec23415b9e454ecfa25ec4d9
Content-Length: 0
Server: Tengine

Interface details

  • Please refer to ACL for the meaning of bucket permission .
  • When ACL is set in the header and body at the same time, only those in the header will take effect. When both x-kss-acl and x-kss-grant-* are set in the header, the latter takes effect.
  • For most users, using x-kss-acl to set the preset ACL in the header can meet most requirements. For bucket, you usually need to set x-kss-acl to private.
On this page
Pure ModeNormal Mode

Pure Mode

Click to preview the document content in full screen
Feedback