The following table describes headers that can be used by various types of Sectona APIs. The authorization username must be accesskey (fixed text, no case sensitive) and password must be provided by the user while API registration in Sectona.
|
Header Name |
Header Value |
Required |
Description |
|---|---|---|---|
|
AUTHORIZATION |
username : Accesskey password : {Access key data} |
YES |
Basic authentication and provide username and password for authorization |
|
ACCEPT |
application/json OR text/xml |
OPTIONAL |
Default request accepts is text/JSON |
|
CONTENT-TYPE |
application/json OR text/xml |
OPTIONAL |
Default content type is text/JSON |
|
CACHE-CONTROL |
no-cache |
OPTIONAL |
Forces caches to submit the request to the server for validation before releasing a cached copy |
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 |
DB instance id asset category is database |
|
AccountName |
String |
YES |
Account Name |
|
Instance |
String |
YES |
Instance Name |
Sample Request (JSON)
{
"AssetType":"Unix Based",
"AssetHost":"CENTOS7",
"DBInstance":"",
"AccountName":"admin152",
"Instance":"Default"
}
Sample Response (JSON)
{
“Version”:”6.0.0.0”,
"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 |
|---|---|
|
011652 |
Invalid instance |
|
011670 |
Invalid account details |
|
011672 |
Requested details are not valid or not accessible |
|
011688 |
Invalid access key |
|
011689 |
Invalid request parameters |
|
011691 |
Unable to validate request |
|
011692 |
Unable to get account password |
|
011693 |
Unable to update API log |
|
011803 |
Unable to insert API log details |
|
011853 |
Requested asset is not valid |
|
023601 |
The authorization header name is not valid |
|
023604 |
Requested asset is not valid |