Versions Compared

Key

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

Anchor
_Toc341972482
_Toc341972482
Attributes

Attribute

type

values

default

mandate

comment

activationCode

object





challengeCodes

object





token

object





user

object





isOwner

boolean


true



usageLimit

integer


0(unlimited)



status

string

ACTIVE,
INACTIVE,
LOCKED,
DISABLED

ACTIVE



starts

date





expires

date





priority

integer


0



pin

string



false


lastChangePin

Date



False


mustChangePin

Boolean


False

False


pinNeverExpires

Boolean


False

False








dateCreated

Date



False


lastUpdated

Date



False


Anchor
_Toc341972483
_Toc341972483
tokenAssignment/search

Anchor
_Toc341972484
_Toc341972484
tokenAssignment/set

Anchor
_Toc341972485
_Toc341972485
tokenAssignment/get

Anchor
_Toc341972486
_Toc341972486
tokenAssignment/activate

Examples:
Method:/tokenAssignment/activate

Code Block
languagejs
titleParameters
{
    "id":asid,
    //or
    "user":{"id":userid},
    "token":{"id":tokenid}, 
    "code":activation code
}


Code Block
languagejs
titleResponse
{
    "error":0,
    "result":{"id":1}
} 



Anchor
_Toc341972487
_Toc341972487
tokenAssignment/sendActivationCode

Examples:
Method:/tokenAssignment/sendActivationCode

Code Block
languagejs
titleParameters
{
    "id":asid,
    //or
    "user":{"id":userid},
    "token":{"id":tokenid},
    "provisioningUrl":"http://xxxx:xxx",
    channel: SMS|SMTP|TWITTER|TELEPHONE
}


Code Block
languagejs
titleResponse
{
    "error":0,
    "result":{"id":1}
}


Anchor
_Toc341972488
_Toc341972488
tokenAssignment/ sendDownloadUrl

Examples:
Method:/tokenAssignment/sendDownloadUrl
Parameters:

Code Block
languagejs
titleParameters
{
    "id":asid,
    //or
    "user":{"id":userid},
    "token":{"id":tokenid},
    "provisioningUrl":"http://xxxx:xxx",
    channel: SMS|SMTP|TWITTER|TELEPHONE
}


Code Block
languagejs
titleResponse
{
    "error":0,
    "result":{"id":1}
}



Anchor
_Toc341972489
_Toc341972489
tokenAssignment/sort

Code Block
languagejs
titleParameters
{
    "ids":["id1","id2","id3","id4"]
}


Code Block
languagejs
titleResponse
{
    "error":0
}


Anchor
_Toc341972489
_Toc341972489
tokenAssignment/getTokenQRCode

Code Block
languagejs
titleParameters
{
    "id":"token assignment id"
}


Code Block
languagejs
titleResponse
{
    "error":0
    "message": "Succeeded",
    "result": "base64 encoded png image"
}

The returned images can be used in html tag directly:

Code Block
languagexml
titleDemo
<img src="data:image/png;base64,the actual data">