authUser (service) [v2]

API version: 2

Availability: DIGIPASS Gateway 5.0 and later

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

The authUser service completes a pending push and login authentication. It resumes an authentication request that the serving OneSpan Authentication Server instance previously suspended during a SOAP call (authUser) from the application server.

The authentication request is retrieved by the client using getPreparedSecureChallenge. The respective authentication request is identified by a challenge key previously received via push notification (see getPreparedSecureChallenge (service) [v2]).

URL

https://dpgateway_host:dpgateway_port/rest/v2/authentication/push /authUser

Request

authUser parameters
Parameter name Data type Description
challengeKey String Required. The unique identifier used by OneSpan Authentication Server to identify a login request.
domain String Optional. The unique identifier used by OneSpan Authentication Server to identify a group user.
signature String Required. The signature generated with the Digipass SDK using the Secure Channel message containing the login details.
userID String Required. The unique identifier used by OneSpan Authentication Server to identify a user.

Example

{
  "userID": "jane.doe",
  "domain": "mydomain.com",
  "challengeKey": "0123456789",
  "signature": "1234567890123456"
}

Response

authUser return values
Return value Description
resultCodes

A JSON object that contains the return and status codes of the service.
result A JSON object that contains the resolved user information and the serial number of the Digipass authenticator that is effectively used to complete the authentication request.

Example

{
  "resultCodes":
    {
      "returnCodeEnum": "RET_SUCCESS",
      "statusCodeEnum": "STAT_SUCCESS",
      "returnCode": 0,
      "statusCode": 0
    },
  "result":
    {
      "userID": "jane.doe",
      "domain": "mydomain.com",
      "orgUnit": "",
      "serialNo": "VDS1000120-1"
    }
}