API - Get Accounts by Asset

Purpose

A post API to get a list of accounts.

Accessing the API

XML

Endpoint: /API/APP/APP007/GetAccountsByAsset

HTTP METHOD

XML

POST

Parameters

Parameters	Data Type	Required	Description
Filter	String	Yes	All /Active/ Disabled
AssetType	String	Yes	Asset type
AssetHost	String	Yes	IP address or host name
DBInstance	String	No	Database instance (required if requested asset is of database category)
Instance	String	Yes	Instance name

Sample Request (JSON)

XML

{
    "Filter":"All/Active/Inactive",
	"AssetType":"Windows Server",
	"AssetHost":"XX.XX.XX.XX",
	"DBInstance":"",
	"Instance":"XXXX"
}

Sample Response (JSON)

XML

{
	“Version”:”6.0.0.0”,
	"IsSuccess":true,
	"LogCode":"0",
	"Result":"
	{
     "Asset":"
	 {
		 "AssetCategory":"String",
		 "AssetType":"String",
		 "HostName":"String",
		 "DBInstance":"String",
		 "IPAddress":"String",
		 "PortNo":"String",
		 "Status":"String",
		 "Instance":"String 
	 },
     "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
032410	Unable to get accounts on asset
011685	Unable to get asset information
011810	Unable to get account
011853	Requested asset is not valid