Common Attributes

Attribute

type

values

default

mandate

comment

name

string

 

 

true

 

description

string

 

 

false

 

type

enum

FAILTHRU_1FA,
FAILTHRU_2FA,
FAILTHRU_ALL

 

true

 

protocol

enum

RADIUS,
LDAP

 

true

 


Radius Server Attributes

Attribute

type

values

default

mandate

comment

ipaddress

string

 

 

true

 

port

integer

 

1812

false

 

timeout

integer

 

5

false

 

retries

integer

 

1

false

 

sharedSecret

string

 

 

true

 


Ldap Server Attributes

Attribute

type

values

default

mandate

comment

url

string

 

 

true

 

accessUserDN

string

 

 

false

 

accessPassword

string

 

 

false

 

loginNameAttribute

String

 

sAMAccountName

false

 

baseDN

string

 

 

false

 


/ failThruServer/ create

Method:/failThruServer/create
Parameters:
{
"attrs":
{
"name":"Test",
"description":"",
"protocol":"RADIUS",
"type":"FAILTHRU_1FA",
"ipaddress":"192.168.1.1",
"port":"1812",
"sharedSecret":"testing123"
}
}
Response:
{
"error":0
}

/ failThruServer / get

Method:/failThruServer /get
Parameters: 
\{
 "match":
\[
  \["name", "=", "Test"\]
\}
"return":\["*",\{"members": \[\{elements:\["id"\]\}\]\}\]
\}
Response: 
\{
"error":0,
"result":
\{
 "name":"Test",
"description":"",
"protocol":"RADIUS",
"type":"FAILTHRU_1FA",
"ipaddress":"192.168.1.1",
"port":"1812",
"timeout":5,
"retries":1
"sharedSecret":"testing123"
\}
\}
\\

/ failThruServer / search

Method:/failThruServer /search
Parameters: 
\{
 "match":
\[
  \["name", "=", "Test"\]
\}
"return":\["*"\]
\}
Response: 
\{
"error":0,
"result":
\{
 "total":1,
 "rows":
\[
\{
 "name":"Test",
"description":"",
"protocol":"RADIUS",
"type":"FAILTHRU_1FA",
"ipaddress":"192.168.1.1",
"port":"1812",
"timeout":5,
"retries":1
"sharedSecret":"testing123"
\}
\]
\}
\\
\\

/ failThruServer / delete

Method:/failThruServer /delete
Parameters:
{
"id":id
}
Response:
{
"error":0
}

/ failThruServer / set

Method:/failThruServer /set
Parameters:
{
"id":id,
"attrs":
{
"port":1913
}
}
Response:
{
"error":0
}