Anchor |
---|
| _Toc341972467 |
---|
| _Toc341972467 |
---|
|
AttributesAttribute | type | values | default | mandate | comment |
---|
serial | string | |
|
| true |
|
Identifier | String | |
|
| true |
|
Status | String | ACTIVE, DISABLED, DECEASED | | | |
|
|
|
description | string | | |
|
| false | |
|
users | coll | | | | |
|
|
|
|
assignedUsers | coll | | | | |
|
|
|
|
sharedUsers | coll | | | | |
|
|
|
|
product | object | | |
|
| true | |
|
repository | object | |
|
| false |
|
Anchor |
---|
| _Toc341972468 |
---|
| _Toc341972468 |
---|
|
/token/create Wiki Markup |
+Examples 1:+
Method:/token/create
Parameters:
\{
1:
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
{
"attrs":
|
...
...
...
"user.id": "userid",
"pin": "tokenpin"
|
...
...
Code Block |
---|
|
{
"error":0,
"result": |
...
...
...
Example 2:
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
{
"attrs":
|
...
...
...
...
...
...
...
...
...
"domain.name":"domain.com",
|
...
...
...
...
Code Block |
---|
|
{
"error":0,
"result": |
...
...
...
...
Anchor |
---|
| _Toc341972469 |
---|
| _Toc341972469 |
---|
|
/token/getExamples:
Method: /token/get
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
{
"match":
[
"serial":"token serial"
],
"return":["id", "serial","status"]
} |
Code Block |
---|
|
{
"error":0,
"result":
{
"id": "token id1",
"serial": "serial1",
"status": "ACTIVE"
}
} |
Anchor |
---|
| _Toc341972470 |
---|
| _Toc341972470 |
---|
|
/token/setExamples:
Method:/token/set
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
{
"id": "token id1",
"attrs":
{
"status": "DISABLED"
}
} |
Anchor |
---|
| _Toc341972471 |
---|
| _Toc341972471 |
---|
|
/token/deleteExamples:
Method:/token/delete
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
...
...
...
...
...
"tokenid1",
"domain.id": "domainId", |
...
...
// Note: if the user
block is given, system will unassign the token from the user instead of delete the token itself
}
...
...
...
Anchor |
---|
| _Toc341972472 |
---|
| _Toc341972472 |
---|
|
/token/resetExamples:
Method:/token/reset
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
...
...
...
...
...
...
...
...
...
...
Anchor |
---|
| _Toc341972473 |
---|
| _Toc341972473 |
---|
|
/token/confineTo confine a token, the token cannot be downloaded again.
Examples:
Method:/token/confine
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
...
...
...
...
...
...
...
Anchor |
---|
| _Toc341972474 |
---|
| _Toc341972474 |
---|
|
/token/releaseTo release a token, the token can be downloaded again
Examples:
Method:/token/release Parameters:
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
{ |
...
...
...
...
...
...
Anchor |
---|
| _Toc341972475 |
---|
| _Toc341972475 |
---|
|
/token/importImport hardware tokens into token repository
Examples:
Wiki Markup |
+Examples:+
Method: /token/create
Parameters:
\{
import
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
{
"attrs":
|
...
...
...
...
...
...
"data":"text of import file"
|
...
...
...
...
Code Block |
---|
|
{
"error":0,
"result":
|
...
...
...
...
...
{"id":"xxx","serial":"1001" |
...
...
{"id":"yyy","serial":"1002" |
...
...
{"id":"zzz","serial":"1003" |
...
...
...
...
...
...
...
/token/...
syncToken
Examples:
Method:/token/getDownloadUrlsyncToken
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
...
...
"user":
{
"id": "userid"
},
"token":
{
"serial":"10000000"
},
"credential":"otp1,otp2"
} |
...
...
/token/...
batchAssignTokens
Examples:
Method:/token/getActivateUrlbatchAssignTokens
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
...
...
"attrs":
{
"csv": "content of csv file",
"charset":"UTF-8"
}
} |
Format of the CSV file:
Code Block |
---|
|
domain,loginName,manufacturerCode,productCode,serial,status,pin
"test domain", "john.smith", "DN", "MT", "10000", "ACTIVE", "1234" |
Anchor |
---|
| token_download_offline_data |
---|
| token_download_offline_data |
---|
|
/token/downloadOfflineData...
Examples:
Method:/token/syncToken
Parameters:
{
"user":
{
"id":userid
},
"token":
{
"serial":"10000000"
},
"credential":"otp1,otp2"
}
Response:
{
"error":0
}
...
Examples:
Method:/token/retrieveCredentialdownloadOfflineData
Code Block |
---|
language | js |
---|
title | Parameters |
---|
|
...
...
...
...
test-desktop-logon" // has to be the application name in current implementation
},
"encryptionKey":"encryption key", // optional
"tokens": [
{
"id": "df2aac1138fe109b7a7f30c70ede1217" // or other token attributes, serial etc
},
{
"id": "ccd27d2f4dc6ca67430f042578847105"
},
{
"id": "1ee19c081fb26e9461f51e330069a978"
}
],
"user": {
"id": "userid" // or other user attributes, like: "loginName": "acme\\john.smith" etc
},
"return": {
"tokenAssignment": [
"*"
],
"user": [
"loginName",
"email",
"userPrincipalName",
"domain.name",
"domain.netbiosName",
"domain.dnsName"
]
}
} |
Code Block |
---|
|
{
"error": 0,
"message": "Succeeded",
"result": {
"offlineData": "encrypted data encoded in base64"
}
} |