DSAPPGenerateActivationData (service)

API version: 2

Availability: DIGIPASS Gateway 5.0 and later

Authentication: Basic HTTP authentication using the front-end API key.

The DSAPPGenerateActivationData service generates an encrypted full activation data (XFAD) for a standard authenticator or Activation Message 1 for a multi-device licensing (MDL) authenticator.

URL

https://dpgateway_host:dpgateway_port/rest/v2/provisioning /DSAPPGenerateActivationData

Request

DSAPPGenerateActivationData parameters
Parameter name Data type Description
registrationIdentifier String Required. The unique identifier of a user for a given activation process; returned by DSAPPRegister.
dsAppVersion Integer

Required. The version of the communication protocol to use.

Possible values: 1, 2

The current version is 2.
initialVector String Required. The initial vector used during the encryption of the license activation message.
publicKey String Required. The encrypted public key and nonce generated by the mobile application using the DSAPP SDK.

Example

{
  "dsAppVersion": 2,
  "registrationIdentifier": "123456789A",
  "publicKey": "D20AFA7756BD4CBDAF495D8CA4805305...",
  "initialVector": "07D32029F8FA298E0A354927106F753C"
}

Response

DSAPPGenerateActivationData return values
Return value Description
resultCodes A JSON object that contains the return and status codes of the service.
serverTimeResult A JSON object that contains the current server time as Unix time. This is the number of seconds that have elapsed since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC). Leap seconds are not counted.
result A JSON object that contains the generated activation data.

Example

{
  "resultCodes":
    {
      "returnCodeEnum": "RET_SUCCESS",
      "statusCodeEnum": "STAT_SUCCESS",
      "returnCode": 0,
      "statusCode": 0
    },
  "serverTimeResult":
    {
      "serverTime": 1547472526
    },
  "result":
    {
      "userID": "jane.doe",
      "domain": "mydomain.com",
      "serverIV": "99565048F29D69AFFB9BBF7C34386505",
      "encryptedNonces": "DA3AAE32102BE4FA95AF1B3D25667B11",
      "encryptedServerPublicKey": "D9C35501B0B6AF4BDE9CDEED0FC59E6A...",
      "activationMessage": "DEC85FF288C11DC573BC60B78B16056D...",
      "activationMessageIV": "20E35B72D523BEE6A10FB0BA3F846795",
      "eventReactivationCounter": "",
    }
}