getAppUpgradeInfo (Command)

  • Published on Jul 7, 2025
  • 1 minute(s) read
Prev Next

With the getAppUpgradeInfo command the user can update the OneSpan Mobile Authenticator app to a version that supports push notifications.

Parameters

  Table: getAppUpgradeInfo input parameters (SOAP provisioning)
Parameter nameData typeDescription
componentTypeStringRequired. Specifies the client component to serve the request.
userUserInputRequired. The user input information (see UserInput (Data type)). This specifies the user to be authenticated for the provisioning operation.
serialNumberStringRequired. The serial number of the authenticator used for updating the device.
  Table: getAppUpgradeInfo output parameters (SOAP provisioning)
Parameter nameData typeDescription
statusCommandStatusResponse

Required. The error stack, if applicable, which indicates that the command has not completed successfully. This also includes the result and status codes returned by the command.

resultGetAppUpgradeInfoResultRequired. The output field for this command, returning information about the upgrade procedure result (Secure Channel message).

UserInput (Data type)

  Table:  UserInput (Data type)
Element nameData typeDescription
userIDStringThe user ID.
domainStringOptional. The user domain.

GetAppUpgradeInfoResult (Data type)

  Table: getAppUpgradeInfoResult (Data type) 
Parameter nameData typeDescription
upgradeMessagehexBinary

Required. A string converted to a hex string and encrypted as a Secure Channel message. It contains upgrade-relevant information, including the user, the user's domain, and the DIGIPASS Gateway ID.

Example:

"01;02;myUserID;myDomain;0123456789"

30313B30323B6D795573657249443B6D...

Example

 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <prov:getAppUpgradeInfo xmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Provisioning">
      <componentType>Push Notification Client</componentType>
      <user>
        <userID>user1</userID>
        <domain>Master</domain>
      </user>
      <serialNumber>12345678</serialNumber>
    </prov:getAppUpgradeInfo>
  </soapenv:Body>
</soapenv:Envelope>