online (service)
This command is deprecated! Use authUser (service) instead!
API version: 1
Availability: DIGIPASS Gateway 5.0 and later
Authentication: Basic HTTP authentication using the front-end API key.
The online service performs an online authentication.
URL
https://dpgateway_host:dpgateway_port/rest/auth/online
Request
online 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. |
| otp
|
String |
Required.The one-time password (OTP) generated with the Digipass SDK. |
Example
{
"userID": "myUserID",
"domain": "myDomain",
"otp": "1234567890123456"
}
Response
online return values
| Return value |
Data type |
Description |
| errorCode
|
Integer |
The return code provided by OneSpan Authentication Server. 0 is returned in case of success. |
| errorMessage
|
String |
The error message provided by OneSpan Authentication Server. STAT_SUCCESS is returned in case of success. |
Example
{
"errorCode": 0,
"errorMessage": "STAT_SUCCESS"
}