Purpose
A post API to map or un-map account with account group.
Accessing the API
Endpoint: /API/APP/APP007/AccountGroupAction
HTTP METHOD
POST
Parameters
|
Parameters |
Data Type |
Required |
Description |
|---|---|---|---|
|
Action |
String |
Yes |
(map/unmap) |
|
GroupName |
String |
Yes |
GroupName |
|
AccountName |
String |
Yes |
AccountName |
|
AssetType |
String |
Yes |
AssetType |
|
AssetHost |
String |
Yes |
IP address or host name |
|
DBInstance |
String |
No |
Database Instance (required when asset category is database) |
|
AccountType |
String |
No |
Local, AD Account (Default is Local if not provided) |
|
Instance |
String |
Yes |
Instance name |
Sample Request (JSON)
{
"GroupName":"",
"AssetType":"Windows Server",
"AssetHost":"host or IP address",
"DBInstance":"",
"AccountName":"Account Name",
"AccountType":"Local/ADAccount",
"Action":"map/unmap",
"Instance":"Instance name"
}
Sample Response (JSON)
{
“Version”:”6.0.0.0”,
"IsSuccess":true,
"LogCode":"0",
"Result":"account XXXX unmapped from group (XXXX)",
"StatusCode":"Accepted",
"Timestamp":"03 Jun 2019 12:20:10 GMT 05:30:00"
}
Standard Error Response Codes
|
Error Code |
Error Description |
|---|---|
|
011649 |
Current user lacks permission to perform this 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 |
|
032412 |
Unable to map account with account group |
|
011671 |
Invalid account name |
|
011685 |
Unable to get asset information |
|
011690 |
Account does not belong to asset |
|
011804 |
Unable to get account group |
|
011814 |
Unable to map account with account group |
|
011853 |
Requested asset is not valid |