Purpose
A post API to get a list of accounts using the group name parameter.
Accessing the API
Endpoint: /API/APP/APP007/GetAccountsByGroup
HTTP METHOD
POST
Parameters
|
Parameters |
Data Type |
Required |
Description |
|---|---|---|---|
|
Filter |
String |
YES |
All/Active/Disabled |
|
Group Name |
String |
YES |
Account group name |
|
Instance |
String |
YES |
Instance name |
Sample Request (JSON)
{
"Filter":"All/Active/Disabled",
"GroupName":"Group name",
"Instance":"Instance name",
}
Sample Response (JSON)
{
“Version”:”6.0.0.0”,
"IsSuccess":true,
"LogCode":"0",
"Result":"
{
"GroupName":"",
"Accounts":
{
[
"AssetType":"String",
"AssetHost":"String",
"DBInstace":"String",
"AccountName":"String",
"DirectoryServer":"String",
"AccountAuthenticationType":"String",
"AccountType":"String",
"Owner":"String",
"Tags":["T1", "T2"],
"Category":"String",
"ConsoleAccess":"String",
"EnforcePasswordChange":"String",
"IsExcludeFromADSync":"String",
"Config1":"String",
"Config2":"String",
"Config3":"String",
"Config4":"String",
"InheritCheckoutPolicyFromAsset":true/false,
"CheckoutPolicy":"String",
"InheritRotationPolicyFromAsset":true/false,
"RotationPolicy":"String",
"InheritReconciliationPolicyFromAsset":true/false,
"ReconciliationPolicy":"String",
"CreatedBy":"String",
"CreatedOn":"String",
"Status":true/false,
"Instance":"String",
"LinkedGroups":["G1", "G2"]
]
},
},
"StatusCode":"Accepted",
"Timestamp":"03 Jun 2019 11:58:50 GMT 05:30:00"
}
Standard Error Response Codes
|
Error Code |
Error Description |
|---|---|
|
011649 |
Current user do not have permission to take an 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 |
|
032411 |
Unable to get accounts by group |
|
011804 |
Unable to get account group |
|
011811 |
Unable to get accounts by group |