Skip to main content

Start token activation

POST 
/api/web/v1/tokens/:tokenid/activation

Start activation of the given token. Caller requires the TOKENS:ADD permission.

Request​

Path Parameters

    tokenid stringrequired

    The UUID of the token to be activated.

Body

    deliverActivationEmail boolean

    A flag indicating if Identity as a Service should send an activation email including the activation information to the end user. If not specified, this attribute defaults to false.

    returnQRCode boolean

    A flag indicating if the QR code for offline activation is returned. The link encoded in the QR code is always returned for clients that want to encode their own QR code. If not specified, this attribute defaults to false.

    type string[]

    Possible values: [CLASSIC, ONLINE, OFFLINE]

    The list of activation types that will be performed. Allowed values are: CLASSIC (return activation values that must be manually entered into the mobile application), ONLINE (return a link that when clicked will launch the mobile application) and OFFLINE (return a QR code that can be scanned by the mobile application). If no values are specified in the list, then all activation types are performed.

Responses​

Successful

Schema

    activationAddress string

    The activation address for the token. This value should be entered into the Mobile ST application if you want to perform manual activaiton.

    activationCode string

    The activation code for the token. This value should be entered into the Mobile ST application if you want to perform manual activation

    activationOnlineHttpURL string

    The HTTP activation URL. Clicking on this URL on your mobile device will redirect you to the Mobile ST application to perform activation.

    activationOnlineURL string

    The application specific activation URL. Clicking on this URL on your mobile device will launch the Mobile ST application to perform activation.

    activationPassword string

    If the Mobile ST prompts you to enter an activation password during activation, this attribute is the password you must enter.

    activationQRCode string

    The base-64 encoded activation QR code. This QR code can be scanned by the Mobile ST application to perform activation.

    activationURL string

    The URL encoded in the activation QR code.

    serialNumber string

    The serial number of the token.

Loading...