API - Password Vault
Purpose
To add a user using Sectona's API interface.
Accessing the API
Endpoint: /API/APP/APP008/RequestPassword
HTTP METHOD
POST
Authorization: This API uses access key data for authorization purposes
Parameters
Parameters | Data Type | Required | Description |
---|---|---|---|
AssetType | String | YES | Asset type |
AssetHost | String | YES | Host name or IP address |
DBInstance | String | OPTIONAL | Database instance if asset category is database |
AccountName | String | YES | Account name |
Instance | String | YES | Instance name |
Sample Request (JSON)
{
"AssetType":"Unix Based",
"AssetHost":"CENTOS7",
"DBInstance":"",
"AccountName":"*****",
"Instance":"Default"
}
Sample Response (JSON)
{
"Version":"X.X.X.X",
"IsSuccess":true,
"LogCode":"0",
"Result":
"{
"AssetType": "Unix Based",
"AssetHost": "XXXXXX",
"AccountName": "XXXXXX",
"AccountAuthenticationType": "KeyBased_SecretKey",
"AccountType": "Local",
"Password": "XXXXXX",
"PassPhrase": "XXXXXX",
"CreatedBy": "",
"CreatedOn": "03 Jun 2019 15:22:11 GMT 05:30:00",
"Status": "Active"
}",
"StatusCode":"Accepted",
"Timestamp":"03 Jun 2019 15:38:18 GMT 05:30:00"
}
Standard Error Response Codes
Error Code | Error Description |
---|---|
011670 | UI description |
011671 | Invalid account details |
011672 | Invalid account name |
011688 | Requested details are not valid or unaccessible |
011689 | Invalid access key |
011690 | Invalid request parameters |
011691 | Account does not belong to asset |
011692 | Unable to validate request |
011693 | Unable to get account password |
011694 | Unable to read response |