authUser (service)

API version: 2

Availability: DIGIPASS Gateway 5.0 and later

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

The authUser service performs an online authentication.

URL

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

Request

authUser parameters
Parameter name Data type Description
userID String Required. The unique identifier used by OneSpan Authentication Server to identify a user.
domain String Optional. The unique identifier used by OneSpan Authentication Server to identify a group user.
password String Required. The one-time password (OTP) generated by the authenticator.

Example

{
  "userID": "jane.doe",
  "domain": "mydomain.com",
  "password": "123456"
}

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"
    }
}