Attributes

Attribute

type

values

mandate

comment

type

string

MANAGEMENT_CONSOLE,
WEB_AGENT,
WINDOWS_AGENT,
RADIUS_AGENT,
SSO_SERVER

true


typeDescription

string




name

string


true


description

string


false


applications

coll


false


ipaddress

string


true


subjectDn

string


true

immutable

signature

string


false

readonly

caCertificate

String



readonly,PEM encoded

certificate

String



readonly,PEM encoded

certificatePfx

binary



readonly,Base64 encoded

certificateJks

binary



readonly,Base64 encoded

certificatePassword

string



readonly

agentConfigurePack

binary



readonly

publicUrl

String





/agent/create


+Examples:+
Method:/agent/create
Parameters: 
\{
 "attrs":
\{
type:"WEB_AGENT",
 ipaddress:"192.168.222.9",
 name:"testAgent1",
 description:"an agent",
 subjectDn:"CN=agent test,L=Milton Keynes,OU=R&D,O=Deepnet,C=UK",
//data:"xxxx some data xxx",
 applications:\[\[id:aid1\],\[id:aid2\]\]
\},
"return": \["id", "certificatePfx", "agentConfigurePack"\]
\}
Response: 
\{
 "error":0,
"result":\{"id":1\}
\}


/agent/listTypes


+Examples:+
Method:/agent/listTypes
Parameters: 
\{
\}
Response: 
\{
 "error":0,
"result":
\{
"total":5,
"rows":
\[
\{"value":"MANAGEMENT_CONSOLE","description":"Management Console"\},
\{"value":"WEB_AGENT","description":"Web Agent"\},
\{"value":"WINDOWS_AGENT","description":"Windows Agent"\},
\{"value":"RADIUS_AGENT","description":"RADIUS Agent"\},
\{"value":"OTHERS_AGENT","description":"Other Agent"\}
\]
\}
\}
\\


/agent/listApplications


+Examples:+
Method:/agent/listApplications
Parameters: 
\{
"return": \["*"\]
\}
Response: 
\{
 "error":0,
"result":
\{
"total":2,
"rows":
\[
 \{
 "id":"aid1",
 "name":"aaa application"
\},
 \{
 "id":"aid2",
 "name":"aaa application 2"
\}
\]
\}
\}
\\
\\
\\
\\


/agent/addApplication

{
    "agent": {"id":"agent id"}, // name etc will also work
    "application": {"id": "application id"}, // name etc will also work
}

/agent/removeApplication

{
    "agent": {"id":"agent id"}, // name etc will also work
    "application": {"id": "application id"}, // name etc will also work
}