Getting Accounts

In this article

    You can get a list of existing cloud credentials.

    Request

    GET https://<hostname>:4443/v5/Accounts/

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    The response contains the following information:

    Property

    Type

    Description

    id

    string

    An account identification number.

    accountType

    string

    An account type:

    • azureBlobAccount
    • amazonS3Account
    • amazonS3CompatibleAccount

    userName

    string

    An account user name.

    description

    string

    An account description.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    Request:

    GET https://abc.tech.local:4443/v5/Accounts

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

         {

         "accountType": "amazonS3Account",

         "userName": "XXXXXXXXXXXXXXXXXX",

         "_links": {"self": {"href": "https://abc.tech.local:4443/v5/accounts/2c647a18-d475-49c2-8401-0fe72e787c70"}},

         "id": "2c647a18-d475-49c2-8401-0fe72e787c70",

         "description": "Created by ABC/Administrator at 7/25/2019 3:27 AM."

      },

         {

         "accountType": "amazonS3Account",

         "userName": "XXXXXXXXXXXXXXXXXX",

         "_links": {"self": {"href": "https://abc.tech.local:4443/v5/accounts/5f469f02-0f5b-435e-801d-bd453492451b"}},

         "id": "5f469f02-0f5b-435e-801d-bd453492451b",

         "description": "Created by ABC/Administrator at 7/25/2019 3:27 AM."

      },

         {

         "accountType": "azureBlobAccount",

         "userName": "XXXXXXXXXXXXXXXXXX",

         "_links": {"self": {"href": "https://abc.tech.local:4443/v5/accounts/db1befe9-f6cc-4e94-b473-7d6b4a52a6bf"}},

         "id": "db1befe9-f6cc-4e94-b473-7d6b4a52a6bf",

         "description": "Created by ABC/Administrator at 7/25/2019 4:22 AM."

      },

         {

         "accountType": "azureBlobAccount",

         "userName": "XXXXXXXXXXXXXXXXXX",

         "_links": {"self": {"href": "https://abc.tech.local:4443/v5/accounts/695f83f3-5af0-4488-9103-7ffe9db29654"}},

         "id": "695f83f3-5af0-4488-9103-7ffe9db29654",

         "description": "Created by ABC/Administrator at 7/25/2019 4:23 AM."

      }

    ]