API - Manage Account
Purpose
A post API to create and modify an account as well as update password of an account in Sectona.
Accessing the API
Endpoint: /API/APP/APP007/ManageAccount
HTTP METHOD
POST
Parameters
Parameters | Data Type | Required | Description |
---|---|---|---|
APIActionType | String | YES | Create |
AssetType | String | YES | Asset type |
AssetHost | String | YES | Asset host |
DBInstance | String | OPTIONAL | DB instance |
AccountName | String | YES | Account Name |
NewAccountName | String | OPTIONAL | New Account Name |
AccountType | String | YES | Local, ADAccount, JITAccount |
NewAccountType | String | Optional | Local, ADAccount |
AuthenticationType | String | YES | Password, Key Based, Key Based + Secret Key |
Password | String | YES | Account password |
PassPhrase | String | OPTIONAL | Secret key if account has access and passphrase if account is key-based |
Owner | String | OPTIONAL | Owner of an account |
AccountCategory | String | YES | Interactive Account/ Service Account |
OnlyConsoleAccess | True/False | YES | Only console access |
EnforcePasswordChange | True/False | YES | Apply password change policy |
Tags | String | OPTIONAL | Tags |
Instance | String | YES | Instance name |
IsActive | True/False | YES | Status of an account |
Instance | String | OPTIONAL | Instance name |
Tags | String | OPTIONAL | Specifies tags to identify user |
IsActive | true/false | YES | Specify user enable in Sectona. Default is enabled. |
Sample Request (JSON)
{
"APIActionType" : "String",
"AssetType":"UnixBased",
"AssetHost":"XXXXX",
"DBInstance":"",
"AccountName":" XXXXX _",
"NewAccountName":" XXXXX _",
"AuthenticationType":"Password",
"AccountType":"Local",
"Password":" XXXXX ",
"PassPhrase":"",
"Owner":" XXXXX ",
"AccountCategory":"InteractiveAccount",
"OnlyConsoleAccess":false,
"EnforcePasswordChange":false,
"Tags":"",
"Instance":"Default",
"IsActive":true
}
Sample Response (JSON)
{
"Version":"3.7.0.0",
"IsSuccess":true,
"LogCode":"0",
"Message":"Account 0.0.0.0@XX Created/updated successfully",
"StatusCode":"OK",
"Timestamp":"22 Apr 2019 18:34:53 GMT 05:30:00"
}
Standard Error Response Codes
Error Code | Error Description |
---|---|
011649 | Current user do not have permission to take action |
011651 | The authorization header is either empty or not basic |
011673 | Invalid credentials |
011674 | Invalid credentials |
011675 | Unable to validate request |
011683 | Invalid instance name |
011803 | Unable to insert api log details |
032403 | The system was unable to create account |
032420 | Requested asset is not valid |
011681 | Unable to get account properties |
011682 | Unable to perform action |
011853 | Requested asset is not valid |
011661 | Invalid tags |