Anchor |
---|
| _Toc341972345 |
---|
| _Toc341972345 |
---|
|
/auth/listApplicationsParameters:
Code Block |
---|
|
{
"return":["id","name"]
} |
...
Code Block |
---|
|
{
"error":0,
"result":
{
"total":2,
"rows":
[
{
"id":"aid1",
"name":"application 1"
},
{
"id":"aid2",
"name":"application 2"
}
]
}
} |
Anchor |
---|
| _Toc341972346 |
---|
| _Toc341972346 |
---|
|
/auth/listDomainsParameters:
Code Block |
---|
|
{
"application":
{
"id":"appid"
},
"return":["id","name"]
} |
...
Code Block |
---|
|
{
"error":0,
"result":
{
"total":2,
"rows":
[
{
"id":"domain id 1",
"name":"domain 1"
},
{
"id":"domain id 2",
"name":"domain 2"
}
]
}
} |
Anchor |
---|
| _Toc341972347 |
---|
| _Toc341972347 |
---|
|
/auth/listAuthenticatorsList authenticators in the specified logon step.
Parameters:
Code Block |
---|
|
{
"step": 1// step is 1-based
"application":
{
"id":"appid"
},
"user":
{
"domain.id":"domainid",
"loginName":"login name"
}
}
|
...
Code Block |
---|
|
{
"error":0,
"result":
{
"total":2,
"rows":
[
{"code":"OTP", "name":"One-Time Password"},
{"code":"OTPoD", "name":"On-Demand Password"}
]
}
} |
Anchor |
---|
| _Toc341972348 |
---|
| _Toc341972348 |
---|
|
/auth/getLogonStepsParameters:
Code Block |
---|
|
{
"application":
{
"id": "appid"
},
"user":
{
"loginName": "user login name"
},
"return":["name","challengResponse","authenticators"]
} |
...
Code Block |
---|
|
{
"error":0,
"result":
{
"total":2,
"rows":
[
{
"name": "step 1",
"challengResponse": false,
"authenticators":
[
{"code":"OTP", "name":"One-Time Password"}
]
},
{
"name": "step 2",
"challengResponse": false,
"authenticators":
[
{"code":"SPASS", "name":"Static Password"}
]
}
]
}
} |
...
listTokenAssignments | | auth_ |
---|
|
...
/auth/...
listTokenAssignments
Examples:
The following example will list all OOBA tokens:
Method: /auth/logonlistTokenAssignments
Parameters:
Code Block |
---|
|
{
"application":
{
"id":"appid"
},
"user":
{
"id":"userid"
},
"token":
{
"serialproduct.functions":"10000000OOBA"
},
"credentialreturn":
{[
"otpid":, "123456status",
//{"cctoken":"121212" // if verifyResponse is required
}["id","serial","oobDeviceModel","oobDeviceType"]}
]
} |
Response:
...
Examples:
Method:/auth/logout
Parameters:
...
...
Examples:
Method:/auth/verify
Parameters:
Code Block |
---|
|
{
"user":
{
"id":userid
},
,
"result":
{
"total":1,
"rows":
[
"id":"dda5f3744f7d7750676acc24f31fe1287085872ff856224655bf55ec501fa2ba","status":"ACTIVE",
"token":
{
"serialid":"10000000bc650db324ef8e2873444e9e1001ac07",
},
"credentialserial":"110000035",
{
"otpoobDeviceModel":"123456Xiaomi M2007J20CG",
//"ccoobDeviceType":"121212" // if verifyResponse is requiredAndroid"
}
]
}
} |
...
...
...
...
{
"error":0
}
...
/auth/logonExamples 1: OTP login
...
Examples:
Method:/auth/verifyResponselogon
Parameters:
Code Block |
---|
|
{
"application":
{
"id":"appid"
},
"user":
{
"id":"userid"
},
"token":
{
"serial":"10000000"
},
"credential":
{
"otp":"123456",
//"cc":"13113131"
}
} |
...
...
121212" // if verifyResponse is required
}
} |
Examples 2: OOBA loginExamples:
Method: /auth/sendOTPlogon
Parameters:
Code Block |
---|
|
{
"userapplication":
{
"loginNameid": "user login nameappid"
},
"tokenuser": // optional
{
"serialid":"10000000userid"
},
"optionstoken": // optional
{
"formatserial":"TEXT|HTML"110000035"
},
"credential":
{
"channelmethod":"SMSOOBA",
"expiretokenId":"2021-01-01T00:00:00"bc650db324ef8e2873444e9e1001ac07",
}
} |
Response:
Anchor |
---|
| _Toc341972350 |
---|
| _Toc341972350 |
---|
|
/auth/logoutExamples:
Method:/auth/logout
Parameters:Send OTP to user "acme\john.smith" via "SMS"
Response:
Code Block |
---|
|
{
"usererror":0
} |
Anchor |
---|
| _Toc341972351 |
---|
| _Toc341972351 |
---|
|
/auth/verifyExamples:
Method:/auth/verify
Parameters:
Code Block |
---|
|
{
"user":
{
"loginNameid": "acme\\john.smith"userid"
},
"optionstoken": // optional
{
"channelserial":"SMS10000000"
},
} |
...
"credential":
{
"otp":"123456",
//"cc":"121212" // if verifyResponse is required
}
} |
Code Block |
---|
|
{
"error "user":0
}
|
...
{
"loginName":"loginName"
},
"credential":
{
"method":"SPASS",
"password":"pass"
}
} |
Response:
Anchor |
---|
| _Toc341972353 |
---|
| _Toc341972353 |
---|
|
/auth/sendOTPExamples:
Method:/auth/sendOTP
Parameters:
Code Block |
---|
|
{
"user":
{
"loginName": "user login name"
},
"token": // optional
{
"serial":"10000000"
},
"options": // optional
{
"format":"TEXT|HTML",
"channel":"SMS",
"expire":"2021-01-01T00:00:00"
}
} |
Send OTP to user "acme\john.smith" via "SMS"Examples:
Method:/auth/sendActivationCode
Parameters:
Code Block |
---|
language | js |
---|
title | Example 12 |
---|
|
{
"user":
{
"idloginName":"userid "acme\\john.smith"
},
"tokenoptions":
{
"serialchannel":"10000000SMS"
},
"options":
{
"format":"TEXT|HTML",
"channel":"SMS",
"expire":"2021-01-01T00:00:00"
}
} |
Code Block |
---|
}
} |
Response:
Anchor |
---|
| _Toc341972354 |
---|
| _Toc341972354 |
---|
|
/auth/sendActivationCodeExamples:
Method:/auth/sendActivationCode
Parameters:
Code Block |
---|
|
{
"user":
{
"id":"userid"
},
"token |
|
{
"tokenAssignment":
{
"idserial":"token assignment id10000000"
},
"options":
{
"format":"TEXT|HTML",
"channel":"SMS",
"expire":"2021-01-01T00:00:00"
}
} |
...
...
Code Block |
---|
|
{
"usertokenAssignment":
{
"id":userid"token assignment id"
},
"tokenoptions":
{
"serialformat":"10000000TEXT|HTML",
} "channel":"SMS",
"expire"credential":"otp1,otp2":"2021-01-01T00:00:00"
}
} |
Response:
...
...
/auth/...
syncToken
Examples:
Method:/auth/downloadTokensyncToken
Parameters:
Code Block |
---|
|
{
"user":
{
"id":"userid"
},
"token":
{
"serial":"10000000"
},
"acHashcredential": "SHA1 hash of activation code in base64 encoded"otp1,otp2"
} |
Response:
...
...
/auth/...
downloadToken
Examples:
Method:/auth/activateTokenAssignmentdownloadToken
Parameters: :
Code Block |
---|
|
{ |
Code Block |
---|
|
{
// "tokenAssignment":{"id":assid}
"user":
{
"id":"userid"
},
"token":
{
"serial":"10000000"
},
"acHash": "SHA1 hash of activation code in base64 encoded"
} |
...
...
...
/auth/...
activateTokenAssignment
Examples:
...
Method:/auth/
...
activateTokenAssignment
Parameters:
Code Block |
---|
|
{
// "tokenAssignment":{"id":assid}
"user
\{
"application":
\ {
"nameid":"appnameuserid"
\ },
"usertoken":
\ {
"loginNameserial":"login name"10000000"
},
"domain.id":domainid
\},
"category":
\{
"name":"logon"
\},
"return":\["name", "id","options"\]
\}
Response:
\{
"error":0,
"result":
\{
"id":"1",
"name":"System logon policy",
"options":
\{
"key":"value",
...
\}
\}
\} |
...
acHash":"SHA1 hash of activation code in base64 encoded"
} |
Response:
Anchor |
---|
| _Toc341972358 |
---|
| _Toc341972358 |
---|
|
/auth/getPolicyParameters:
Code Block |
---|
|
{
"application":
{
"name":"appname"
},
"user":
{
"loginName":"login name",
"domain.id":"domainid"
},
"category":
{
"name":"logon"
},
"return":["name", "id","options"]
} |
Response:
Code Block |
---|
|
{
"error":0,
"result":
{
"id":"policy id 1",
"name":"System logon policy",
"options":
{
"key1":"value1",
"key2":"value2",
...
}
}
|
...
Wiki Markup |
---|
+Examples:+
Method:/auth/listUsers
Parameters:
\{
"user":
\{
"loginName":"login name",
"domain.id":domainid
\}
return:\["*"\]
\}
Response:
\{
"error":0,
"result":\{"id":1,…\}
\} |
Anchor |
---|
| _Toc341972360 |
---|
| _Toc341972360 |
---|
|
/auth/listSiteStamps...
Parameters:
Code Block |
---|
|
{
|
Wiki Markup |
---|
+Examples:+
Method:/auth/listSiteStamps
Parameters:
\{
"user":
\ {
"id":"userid"
\ }
return:\["*"\]
\}
Response:
\{
"error":0,
"result":\{"id":1, …\}
\}
\\
\\} |
Response:
Code Block |
---|
|
{
"error":0,
"result":
{
"total":2,
"rows":
[
{"id":"id1", …},
{"id":"id2", …}
]
}
} |
...
/auth/getChallengeCode...
Parameters:
Code Block |
---|
|
\{
"user":
\ {
"loginName":"login name",
"domain.id":"domainid"
\ },
"token":
\ {
"id":"tid1"
\ },
return:\["id", "code", "starts", "expires"\]
\}
|
Response:
Code Block |
---|
|
\{
"error":0,
"result":\{"id":1, "code":"xxx", "starts":"xxx", "expires":"xxx"\}
\}
\\
+ |
Examples:
...
The
...
GridGo
...
challenge
...
code
...
is
...
the
...
matrix
...
in
...
JSON string
Code Block |
---|
|
{
string
\\
Parameters:
\{
"user":
\ {
"loginName":"login name",
"domain.id":"domainid"
\ },
"token":
\ {
"product.method":"GridGo"
\ },
\\
"return":\["id", "code", "reference"\]
\}
|
Response:
Code Block |
---|
|
\{
"error":0,
"result":
\ {
"id":"#i#_ChallengeCode_22",
"code":
' "{\{"grid\":[\["53c1s3npxgws4pw6jp5kx3\",
\"scmmu698wp9t1sag5spxzz\",
\"gmmzdj97x3jn4bpe9cvu1r\",
\"ps0hs5g2nh5xer6r93fj7x\",
\"mn8zbs5nnnm8rxt2r5ekd0\",
\"0jr935hx618a3vcvzdehn0\",
\"9xtr71jff7jaz255n5rtc4\",
\"dr96rxn7pgs3anmfzpeu7y\",
\"uf06ttmc3kfvhrun2remk9\",
\"z7c3ytf9u2xtfmc60p06ax\"\],
\"rows\":10,
\"cols\":22,
\"indiecs\":\"ABCDEFGHJKMNPRSTUVWXY\"
\ }'",
"reference":"10948e64-b829-47be-be2a-414217bee16f"
\ }
\} |
...
/auth/listTokens...
Parameters:
Code Block |
---|
|
\{
"user":
\ {
"loginName":"login name",
"domain.id":"domainid"
\ },
"token":
\ {
"product.method":"GridCard"
\ },
\\
"return":\["id", "serial"\]
\}
|
Response:
Code Block |
---|
|
\{
"error":0,
"result":
\ {
"total":2,
"rows":
\ [
\ {"id":1"tid1", "serial":"77003456"\},
\ {"id":2"tid2", "serial":"77003457"\}
\ ]
\ }
\}
\\ |
Anchor |
---|
| _Toc341972363 |
---|
| _Toc341972363 |
---|
|
/auth/changePasswordExamples:
Method:/auth/changePassword
Parameters:
...
...
{
"loginName":"login name", |
...
...
...
...
...
Response:
...
...
Anchor |
---|
| _Toc341972364 |
---|
| _Toc341972364 |
---|
|
/auth/verifyPinExamples:
Method:/auth/verifyPin
1. verify password
Parameters:
...
...
{
"loginName":"login name", |
...
"domain.id":"domainid"
},
"pin":"password"
} |
2.
},
"pin":"password"
}
Response:
{
"error":0
} verify pin
Parameters:
...
...
{
"loginName":"login name", |
...
...
...
...
...
...
...
Response:{
...
3. verify pin by assignment
Parameters:
...
...
{
"loginName":"login name", |
...
...
...
...
...
...
...
Response:
...
...