Versions Compared

Old Version 2

changes.mady.by.user Adam Darwin

Saved on

compared with

New Version Current

changes.mady.by.user Adam Darwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Anchor
_Toc341972467
_Toc341972467
Attributes

Attribute

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
languagejs
titleParameters
{
	"attrs":

...

	[

...

		"product.id": "pid",

...

		"user.id": "userid",
		"pin": "tokenpin"

...

	]

...

}


Code Block
languagejs
titleResponse
{
	"error":0,
	"result":

...


	{
		"id":

...

 "tokenid1" 
	}

...

}


Example 2:

Code Block
languagejs
titleParameters
{
	"attrs":

...

	[

...

		"product":

...

		{

...

			"manufacturerCode":"DN",

...

			"productCode":"MT"

...

		},

...

		"user":

...

		{

...

			"domain.name":"domain.com",

...

			"loginNam":"john.smith"

...

		}
		"pin": "tokenpin"

...

	]

...

}


Code Block
languagejs
titleResponse
{
	"error":0,
	"result":

...


	{
		"id":

...

 "tokenid1" 
	}

...

}

...

 Anchor
_Toc341972469
_Toc341972469
/token/get
Examples:
Method: /token/get
 Code Block
languagejs
titleParameters
{
	"match":
	[
		"serial":"token serial"
	],
	"return":["id", "serial","status"]
}

 Code Block
languagejs
titleResponse
{
	"error":0,
	"result":
	{
		"id": "token id1",
		"serial": "serial1",
		"status": "ACTIVE"
	}
}
 Anchor
_Toc341972470
_Toc341972470
/token/set
Examples:
Method:/token/set
 Code Block
languagejs
titleParameters
{
	"id": "token id1",
	"attrs":
	{
		"status": "DISABLED"
	}
}

 Code Block
languagejs
titleResponse
{
	"error":0
}
 Anchor
_Toc341972471
_Toc341972471
/token/delete
Examples:
Method:/token/delete
 Code Block
languagejs
titleParameters
...
{
...

	"id":"token id"
...

	"user":
...

	{
		"id":
...
 "tokenid1",
		"domain.id": "domainId",
...

		"loginName":
...
 "loginName"
	}

}
 // Note: if the user block is given, system will unassign the token from the user instead of delete the token itself
 }
 Code Block
languagejs
titleResponse
...
{
...

	"error":0
...

}

 Anchor
_Toc341972472
_Toc341972472
/token/reset
Examples:
Method:/token/reset
 Code Block
languagejs
titleParameters
...
{
...

	"token":
...

	{
		"serial":"10000000"
...

	},
...

	"attrs": //optional
...

	{
		"counter":0
...

	}
}

 Code Block
languagejs
titleResponse
...
{
...

	"error":0
...

}
 Anchor
_Toc341972473
_Toc341972473
/token/confine
To confine a token, the token cannot be downloaded again.
Examples:
Method:/token/confine
 Code Block
languagejs
titleParameters
...
{
...

	"token":
...

	{
		"serial":"10000000"
...

	}
}

 Code Block
languagejs
titleResponse
...
{
...

	"error":0
...

}
 Anchor
_Toc341972474
_Toc341972474
/token/release
To release a token, the token can be downloaded again
Examples:
Method:/token/release Parameters: 
 Code Block
languagejs
titleParameters
{
...

	"token":
...

	{
		"serial":"10000000"
...

	}
}

 Code Block
languagejs
titleResponse
...
{
...

	"error":0
...

}
 Anchor
_Toc341972475
_Toc341972475
/token/import
Import hardware tokens into token repository
Examples:
 Wiki Markup+Examples:+
Method: /token/create
Parameters: 
\{
 import
 Code Block
languagejs
titleParameters
{
	"attrs":

...
	{

...
		"product.id":
...
 "productId",

...
		"repository.id":
...
 "repoId",

...
		"data":"text of import file"

...
	}
	"return":
...
["id","serial"
...
]

...
}

 Code Block
languagejs
titleResponse
{
	"error":0,
	"result":

...
	{

...
		"total":3,

...
		"rows":

...
		[

...
			{"id":"xxx","serial":"1001"
...
},

...
			{"id":"yyy","serial":"1002"
...
},

...
			{"id":"zzz","serial":"1003"
...
}

...
		]

...
	}

...
}
...
 Anchor
_
...
Toc341972478
_
...
Toc341972478
/token/
...
syncToken
Examples:
Method:/token/getDownloadUrlsyncToken
 Code Block
languagejs
titleParameters
...
{
...

	"user":
	{
		"id": "userid"
	},
	"token":
	{
		"serial":"10000000"
	},
	"credential":"otp1,otp2"
}

 Code Block
languagejs
titleResponse
{
	"error":0
}
 Anchor
_
...
Toc341972480
_
...
Toc341972480
/token/
...
batchAssignTokens
Examples:
Method:/token/getActivateUrlbatchAssignTokens
 Code Block
languagejs
titleParameters
...
{
...

	"attrs":
	{
		"csv": "content of csv file",
		"charset":"UTF-8"
	}
}

 Code Block
languagejs
titleResponse
{
	"error":0
}
Format of the CSV file:
 Code Block
titleexample.csv
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
languagejs
titleParameters
...
{
...

    "application":
...
 {
        "name": "
...
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
languagejs
titleResponse
{
    "error": 0,
    "message": "Succeeded",
    "result": {
        "offlineData": "encrypted data encoded in base64"
    }
}