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 |
---|
|
{
"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":
{
,
"result":
{
"total":1,
"rows":
[
"id":"userid"
},
dda5f3744f7d7750676acc24f31fe1287085872ff856224655bf55ec501fa2ba","status":"ACTIVE",
"token":
{ {
"serialid":"10000000bc650db324ef8e2873444e9e1001ac07",
},
"credentialserial":"110000035",
{
"otpoobDeviceModel":"123456Xiaomi M2007J20CG",
// "ccoobDeviceType":"121212" // if verifyResponse is requiredAndroid"
}
]
}
} |
...
...
Anchor |
---|
| _Toc341972349 |
---|
| _Toc341972349 |
---|
|
...
/auth/...
logon
Examples 1: OTP login
Method:/auth/verifyResponselogon
Parameters:
Code Block |
---|
|
{
"application":
{
"id":"appid"
},
"user":
{
"id":"userid"
},
"token":
{
"serial":"10000000"
},
"credential":
{
"otp":"123456",
"cc":"13113131"
"serial":"10000000"
},
"credential":
{
"otp":"123456",
//"cc":"121212" // if verifyResponse is required
}
} |
Examples 2: OOBA login
Method: /auth/logon
Parameters:
Code Block |
---|
|
{
"application":
{
"id":"appid"
},
"user":
{
"id":"userid"
},
"token":
{
"serial":"110000035"
},
"credential":
{
"method":"OOBA",
"tokenId":"bc650db324ef8e2873444e9e1001ac07",
}
} |
Response:
Anchor |
---|
| _Toc341972350 |
---|
| _Toc341972350 |
---|
|
/auth/logoutExamples:
Method:/auth/logout
Parameters:
Response:
Anchor |
---|
| _Toc341972351 |
---|
| _Toc341972351 |
---|
|
/auth/verifyExamples:
Method:/auth/verify
Parameters:
Code Block |
---|
|
{
"user":
{
"id":"userid"
},
"token": // optional
{
"serial":"10000000"
},
"credential":
{
"otp":"123456",
//"cc":"121212" // if verifyResponse is required
}
} |
Code Block |
---|
|
{
"user":
{
"loginName":"loginName"
},
"credential":
{
"method":"SPASS",
"password":"pass"
}
} |
Response:
Anchor |
---|
| _Toc341972353 |
---|
| _Toc341972353 |
---|
|
/auth/sendOTPExamples:
Method:/auth/sendOTP
Parameters:
...
Anchor |
---|
| _Toc341972354 |
---|
| _Toc341972354 |
---|
|
/auth/sendActivationCodeExamples:
Method:/auth/sendActivationCode
Parameters:
...
Anchor |
---|
| _Toc341972355 |
---|
| _Toc341972355 |
---|
|
/auth/syncTokenExamples:
Method:/auth/syncToken
Parameters:
...
Anchor |
---|
| _Toc341972356 |
---|
| _Toc341972356 |
---|
|
/auth/downloadTokenExamples:
Method:/auth/downloadToken
Parameters:
...
Anchor |
---|
| _Toc341972357 |
---|
| _Toc341972357 |
---|
|
/auth/activateTokenAssignmentExamples:
Method:/auth/activateTokenAssignment
Parameters:
...
Anchor |
---|
| _Toc341972358 |
---|
| _Toc341972358 |
---|
|
/auth/getPolicyParameters:
Code Block |
---|
|
{
"application":
{
"name":"appname"
},
"user":
{
"loginName":"login name",
"domain.id":"domainid"
},
"category":
{
"name":"logon"
},
"return":["name", "id","options"]
} |
...
Code Block |
---|
|
{
"error":0,
"result":
{
"id":"policy id 1",
"name":"System logon policy",
"options":
{
"key1":"value1",
"key2":"value2",
...
}
}
} |
Anchor |
---|
| _Toc341972360 |
---|
| _Toc341972360 |
---|
|
/auth/listSiteStampsParameters:
Code Block |
---|
|
{
"user":
{
"id":"userid"
}
return:["*"]
} |
...
Code Block |
---|
|
{
"error":0,
"result":
{
"total":2,
"rows":
[
{"id":"id1", …},
{"id":"id2", …}
]
}
} |
Anchor |
---|
| _Toc341972361 |
---|
| _Toc341972361 |
---|
|
/auth/getChallengeCodeParameters:
Code Block |
---|
|
{
"user":
{
"loginName":"login name",
"domain.id":"domainid"
},
"token":
{
"id":"tid1"
},
return:["id", "code", "starts", "expires"]
} |
...
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"
}
} |
Anchor |
---|
| _Toc341972362 |
---|
| _Toc341972362 |
---|
|
/auth/listTokensParameters:
Code Block |
---|
|
{
"user":
{
"loginName":"login name",
"domain.id":"domainid"
},
"token":
{
"product.method":"GridCard"
},
"return":["id", "serial"]
} |
...
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:
...
Anchor |
---|
| _Toc341972364 |
---|
| _Toc341972364 |
---|
|
/auth/verifyPinExamples:
Method:/auth/verifyPin
...