Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Bucket ACLs

Get information about all bucket ACLs for the specified bucket. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/bucket_acl​?bucket_id={string}[&group_id={string}][&last_page]​[&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}]​[&permission=LIST|READ|WRITE|DELETE|JOB|OWNER][&user_id={string}]

Request Parameters

Parameter	Description	Required
bucket_id	The UUID, name, or other unique attribute for the bucket.	no
group_id a	The UUID, name, or other unique attribute for the group.	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of ACLs to list. Default: all items after page_offset.	no
page_offset	The starting point for the first ACL to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
permission	The permission granted by the ACL. See permission for a description. Values: LIST, READ, WRITE, DELETE, JOB, OWNER	no
user_id a	The UUID, username, or other unique attribute for the user.	no

a.	Parameter values can use wild cards (see Wild Card Syntax).

Responses

Response Elements

<Data>
   <BucketAcl>
      <BucketId>{string}</BucketId>
      <GroupId>{string}</GroupId>
      <Id>{string}</Id>

      <Permission>LIST|READ|WRITE|DELETE|JOB|OWNER</Permission>

      <UserId>{string}</UserId>

   <BucketAcl>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
BucketAcl	The container for information about one ACL.
BucketId	The UUID for the bucket.
GroupId	The UUID for the group granted permission.
Id	The UUID for the ACL.
Permission	The permission granted by this ACL. See permission for a description. Values: LIST, READ, WRITE, DELETE, JOB, OWNER
UserId	The UUID of the user granted permission.

Example

Sample Request

This request gets information about the ACLs for the bucket with the name “bucket1”.

GET http[s]://blackpearl-hostname/_rest_/bucket_acl​?bucket_id=bucket1 HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <BucketAcl>
      <BucketId>a4752f84-f206-4273-bee3-ede8e279e292</BucketId>
      <GroupId/>
      <Id>11d71c40-629e-478a-bfae-514e83a154f2</Id>

      <Permission>OWNER</Permission>

      <UserId>9adea849-42ae-4d94-ad86-85a113a63991</UserId>
   </BucketAcl>
</Data>