Getting Account Properties by Account ID
This section explains how to get a list with properties for the specified account.
Request
GET https://<hostname>:4443/v5/Accounts/{accountId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
|---|---|---|
accountId | string | An identification number of a cloud account. Can be obtained, as described in Getting Accounts. |
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
Property | Type | Description |
|---|---|---|
id | string | An account identification number. |
accountType | string | An account type:
|
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). |
Example
Request: GET https://abc.tech.local:4443/v5/Accounts/2c647a18-d475-49c2-8401-0fe72e787c70
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." ]}] |