.. _GET Service ostor-users:

GET Service ostor-users
-----------------------

Description
~~~~~~~~~~~

Lists information about all users or the user specified by either email or ID.

Requests
~~~~~~~~

Syntax
^^^^^^

::

    GET /?ostor-users HTTP/1.1
    Host: s3.amazonaws.com
    Date: <date>
    Authorization: <authorization_string>

::

    GET /?ostor-users&emailAddress=<value> HTTP/1.1
    Host: s3.amazonaws.com
    Date: <date>
    Authorization: <authorization_string>

::

    GET /?ostor-users&id=<value> HTTP/1.1
    Host: s3.amazonaws.com
    Date: <date>
    Authorization: <authorization_string>

Parameters
^^^^^^^^^^

+------------------+-------------------------------------------------------+----------+
| Parameter        | Description                                           | Required |
+==================+=======================================================+==========+
| ``emailAddress`` | User email address.                                   | No*      |
|                  |                                                       |          |
|                  | Type: string.                                         |          |
|                  |                                                       |          |
|                  | Default value: none.                                  |          |
+------------------+-------------------------------------------------------+----------+
| ``id``           | User ID.                                              | No*      |
|                  |                                                       |          |
|                  | Type: string.                                         |          |
|                  |                                                       |          |
|                  | Default value: none.                                  |          |
+------------------+-------------------------------------------------------+----------+

\* Only one of the required parameters can be set in a single request.

If neither ``emailAddress`` nor ``id`` are set, the response is information about all users, otherwise the response is information about the user with the specified email or ID.

Headers
^^^^^^^

This implementation uses only common request headers.

Responses
~~~~~~~~~

Headers
^^^^^^^

This implementation uses only common response headers.

Body
^^^^

A JSON dictionary with user information in the following format:

::

    {
    "UserEmail" : "<email>"
    "UserId" : "<id>",
    "AWSAccessKeys : [
    {
    "AWSAccessKeyId" : "<access_key>",
    "AWSSecretAccessKey" : "<secret_key>"
    }]
    }
 
Errors
^^^^^^

Returns ``Error Code 400`` if more than one parameter is set.

Examples
~~~~~~~~

Sample Request #1
^^^^^^^^^^^^^^^^^

Returns information about all users

::

    GET /?ostor-users HTTP/1.1
    Host: s3.amazonaws.com
    Date: Wed, 30 Apr 2016 22:32:00 GMT 
    Authorization: <authorization_string>

Sample Response #1
^^^^^^^^^^^^^^^^^^

::

    HTTP/1.1 200 OK
    Transfer-encoding : chunked
    Server : nginx/1.8.1
    Connection : keep-alive
    x-amz-request-id : 80000000000000030003c6b538eedd95
    Date: Wed, 30 Apr 2016 22:32:00 GMT
    Connection:keep-alive
    Content-type : application/json 
    
    [
    {
    "UserEmail": "user@email.com",
    "UserId": "c5bf3c29f0a86585",
    "AWSAccessKeys": [
    {
    "AWSAccessKeyId": "c5bf3c29f0a865851KPQ",
    "AWSSecretAccessKey": "yqt3or2xMFn6mtvPH5Fdrr9nbp2foDCKOCLYjCTb"
    }]
    },
    {
    "UserEmail": "root2@email.com",
    "UserId": "da2ccd035ce34bc3",
    "AWSAccessKeys": [
    {
    "AWSAccessKeyId": "da2ccd035ce34bc3XD5P",
    "AWSSecretAccessKey": "wHfEBQFO7HN7fhoHx45lHHyBInAOOCZTHtvveYlB"
    }]
    },
    {
    "UserEmail": "root0@email.com",
    "UserId": "f82c23f7823589eb",
    "AWSAccessKeys": [
    {
    "AWSAccessKeyId": "f82c23f7823589ebN4KD",
    "AWSSecretAccessKey": "MbKetIRMW8rrZh16yfb2dMj16ejHuBHfOa37bp5V"
    }]
    },
    {
    "UserEmail": "root1@email.com",
    "UserId": "fc06056891f36588",
    "AWSAccessKeys": [
    {
    "AWSAccessKeyId": "fc06056891f36588RMOE",
    "AWSSecretAccessKey": "HHD59Sf9KB4fGOxrjqhzyLBeHsODXD40QZeomKfy"
    }]
    }]

Sample Request #2
^^^^^^^^^^^^^^^^^

Returns information about the user with the ID ``fc06056891f36588``.

::

    GET /?ostor-users&id=fc06056891f36588 HTTP/1.1
    Host: s3.amazonaws.com
    Date: Wed, 30 Apr 2016 22:32:00 GMT 
    Authorization: <authorization_string>
 
Sample Response #2
^^^^^^^^^^^^^^^^^^

::

    HTTP/1.1 200 OK
    Transfer-encoding : chunked
    Server : nginx/1.8.1
    Connection : keep-alive
    x-amz-request-id : 80000000000000030003c6b538eedd95
    Date: Wed, 30 Apr 2016 22:32:00 GMT
    Connection:keep-alive
    Content-type : application/json 
    {
    "UserEmail": "root1@email.com",
    "UserId": "fc06056891f36588",
    "AWSAccessKeys": [
    {
    "AWSAccessKeyId": "fc06056891f36588RMOE",
    "AWSSecretAccessKey": "HHD59Sf9KB4fGOxrjqhzyLBeHsODXD40QZeomKfy"
    }]
    }