cancelAuthUser (Service) [v2]

Prev Next

API version: 2

Availability: DIGIPASS Gateway 5.10 and later

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

The cancelAuthUser service cancels a pending scan and login authentication. The respective authentication is identified by a challenge key previously received on the mobile device by scanning a Cronto image.

URL

https://dpgateway_host:dpgateway_port/rest/v2/authentication/scan/cancelAuthUser

Request

cancelAuthUser parameters

Parameter name

Data type

Description

serialNumber

String

Required. The unique identifier of the Digipass instance. This is the concatenation of the Digipass serial number and the Digipass sequence number, separated by a dash.

challengeKey

String

Required. The challenge key protected by a Secure Channel message generated with the Digipass SDK.

Example

{
  "serialNumber": "VDS1000000-1",
  "challengeKey": "D2602CE39F8CC50398CD40F41924702C..."
}

Response

cancelAuthUser return values

Return value

Description

resultCodes

A JSON object that contains the return and status codes of the service.

Example

{
  "resultCodes":
    {
      "returnCodeEnum": "RET_SUCCESS",
      "statusCodeEnum": "STAT_SUCCESS",
      "returnCode": 0,
      "statusCode": 0
    }
}