management.Account

Estimated reading: 2 minutes 639 views

Namespace:	Management
REST:	https://[hoster-api-host]/1.0/management/account/rest/{method-name}
Scripting:	management.account.{method-name}

The methods of this service provide management information about a user account (such as SSH keys, quotas, etc.) and allow managing it.

Methods

GetSSHKeys

GetSSHKeys (appid, session, isPrivate ) :

Returns a list of the account’s SSH keys stored on the platform.

URL

https://[hoster-api-host]/1.0/management/account/rest/getsshkeys

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
isPrivate : “boolean”

defines whether to return the account’s private (true) or public (false) SSH keys.

Example

Method: POST

https://[hoster-api-host]/1.0/management/account/rest/getsshkeys?session=[string]&appid=[string]&isPrivate=[boolean]

Response

SSHKeyResponse

{
   "dependencies": "JSONArray",
   "error": "string",
   "key": {
      "fingerPrint": "string",
      "hash": "string",
      "id": "int",
      "isDeleted": "boolean",
      "privateKey": "string",
      "publicKey": "string",
      "title": "string",
      "user": "User"
   },
   "keys": [
      {
         "fingerPrint": "string",
         "hash": "string",
         "id": "int",
         "isDeleted": "boolean",
         "privateKey": "string",
         "publicKey": "string",
         "title": "string",
         "user": {
            "authConfig": {
               "id": "int",
               "isActive": "boolean",
               "isConfigured": "boolean",
               "type": "TOTP(0)",
               "useObjectHash": "boolean"
            },
            "authType": "BASIC(0) | TFA(1)",
            "email": "string",
            "externalId": "string",
            "federationType": "string",
            "id": "int",
            "name": "string",
            "phoneNumber": "string",
            "tenantHost": "boolean",
            "tenantId": "string"
         }
      },
      "..."
   ],
   "reason": "int",
   "result": "int",
   "source": "string"
}