Spectra Logic

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

Get Users

Description

Get information about all users. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/user/[?auth_id={string}][&default_data_policy_id={string}][&last_page] [&name={string}][&page_length={32-bit integer}]
[&page_offset={32-bit integer}][&page_start_marker={string}]

Request Parameters 

Parameter	Description	Required
auth_id	The S3 access ID assigned to the user.	no
default_data_ policy_id	The default data policy used if no data policy is specified when the user creates a bucket.	no
last_page	If included, only the last page of results is returned.	no
name	The username of the user.	no
page_length	The maximum number of users to list. Default: all items after page_offset.	no
page_offset	The starting point for the first user 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

Responses

Response Elements

<Data>
   <User>
      <AuthId>{string}</AuthId>
      <DefaultDataPolicyId>{string}</DefaultDatePolicyId>
      <Id>{string}</Id>
      <Name>{string}</Name>
      <SecretKey>{string}</SecretKey>
   </User>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
User	The container for information about one user.
AuthId	The S3 access ID assigned to the user.
DefaultDataPolicy Id	The UUID for the default data policy used if no data policy is specified when this user creates a bucket.
Id	The UUID for the user.
Name	The username of the user.
SecretKey	The S3 secret key assigned to the user.

Example

Sample Request

This request gets information about all users on the gateway.

GET http://blackpearl-hostname/_rest_/user/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <User>
      <AuthId>c381Y3RyYQ==</AuthId>
      <DefaultDataPolicyId/>
      <Id>b136c431-a59e-413e-b03f-23f7b841ac25</Id>
      <Name>user1</Name>
      <SecretKey>grHkEdE5</SecretKey>
   </User>

   <User>
      <AuthId>bMV3dxN1cg==</AuthId>
      <DefaultDataPolicyId/>
      <Id>b136c431-a59e-413e-b03f-23f7b841ac25</Id>
      <Name>user1</Name>
      <SecretKey>GTfLU3pE</SecretKey>
   </User>

</Data>