Bucket:Set Bucket ACL

Search (SHIFT+S)

Set Bucket ACL

PUT /object/bucket/{bucketName}/acl

Updates the ACL for the given bucket. If the buckets's namespace is not specified in the payload, the current user's namespace is used.

bucketName	Name of the bucket for which the ACL is to be updated.

Required Roles

This call has no restrictions.

Prerequisites

The following conditions must be met in order to call this operation.

Bucket must exist.

Request Payload

<bucket_acl>
   <bucket></bucket>
   <namespace></namespace>
   <acl>
      <owner></owner>
      <default_group></default_group>
      <user_acl>
         <user></user>
         <permission></permission>
      </user_acl>
      <group_acl>
         <group></group>
         <permission></permission>
      </group_acl>
      <customgroup_acl>
         <customgroup></customgroup>
         <permission></permission>
      </customgroup_acl>
      <default_group_file_perms></default_group_file_perms>
      <default_group_dir_perms></default_group_dir_perms>
   </acl>
   <permission></permission>
</bucket_acl>

{
  "bucket": "",
  "namespace": "",
  "acl": {
    "owner": "",
    "default_group": "",
    "user_acl": [
      {
        "user": "",
        "permission": [
          ""
        ]
      }
    ],
    "group_acl": [
      {
        "group": "",
        "permission": [
          ""
        ]
      }
    ],
    "customgroup_acl": [
      {
        "customgroup": "",
        "permission": [
          ""
        ]
      }
    ],
    "default_group_file_perms": [
      ""
    ],
    "default_group_dir_perms": [
      ""
    ]
  },
  "permission": [
    ""
  ]
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
bucket_acl
bucket	Bucket name	String
namespace	Namespace name	String
acl
owner	Owner name	String
default_group	Default group	String
user_acl			0-* Elements
user	User name	String
permission	Permission list	String	0-* Elements
group_acl			0-* Elements
group	Group name	String
permission	List of group permissions	String	0-* Elements
customgroup_acl			0-* Elements
customgroup	Custom group name	String
permission	List of custom group permissions	String	0-* Elements
default_group_file_perms	The default group's file permissions	String	0-* Elements
default_group_dir_perms	The default group's directory permissions	String	0-* Elements
permission	Get short permission list for non namespace owner	String	0-* Elements

Response Body

Response indicating Success or Failure of the operation

Examples

Request

PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/acl: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessControlPolicy xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Owner>
    <ID>wuser1@sanity.local</ID>
    <DisplayName>4pVE+eihUpzoVHSgGFqvzCXNSydoRXOo9gdqwGMi</DisplayName>
  </Owner>
  <AccessControlList>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group">
        <URI>http://acs.amazonaws.com/groups/global/AllUsers</URI>
      </Grantee>
      <Permission>WRITE</Permission>
    </Grant>
    <Grant>
      <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser">
        <ID>geotest2@sanity.local</ID>
        <DisplayName>geotest2@sanity.local</DisplayName>
      </Grantee>
      <Permission>FULL_CONTROL</Permission>
    </Grant>
  </AccessControlList>
</AccessControlPolicy>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

Request

PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/acl.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
  "AccessControlPolicy": {
    "-xmlns": "http://s3.amazonaws.com/doc/2006-03-01/",
    "Owner": {
      "ID": "wuser1@sanity.local",
      "DisplayName": "4pVE+eihUpzoVHSgGFqvzCXNSydoRXOo9gdqwGMi"
    },
    "AccessControlList": {
      "Grant": [
        {
          "Grantee": {
            "-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
            "-xsi:type": "Group",
            "URI": "http://acs.amazonaws.com/groups/global/AllUsers"
          },
          "Permission": "WRITE"
        },
        {
          "Grantee": {
            "-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
            "-xsi:type": "CanonicalUser",
            "ID": "geotest2@sanity.local",
            "DisplayName": "geotest2@sanity.local"
          },
          "Permission": "FULL_CONTROL"
        }
      ]
    }
  }
}

Response

HTTP/1.1 200 OK
Content-Type: application/json