Documentation Index

Fetch the complete documentation index at: https://docs.onespan.com/llms.txt

Use this file to discover all available pages before exploring further.

updateNotificationID (Service) [v2]

Prev Next

API version: 2

Availability: DIGIPASS Gateway 5.0 and later

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

The updateNotificationID service updates the push notification identifier (PNID) of a specific authenticator.

URL

https://dpgateway_host:dpgateway_port/rest/v2/notification/push /updateNotificationID

Request

updateNotificationID parameters

Parameter name

Data type

Description

digipassInstanceID

String

Required. The identifier of the authenticator instance to update.

domain

String

Required. The domain of the user.

encryptedNotificationID

String

Required. The notification identifier to set as encrypted Secure Channel message.

userID

String

Required. The user name.

Parameter names are case-sensitive.

Example

{
  "userID": "jane.doe",
  "domain": "myDomain.com",
  "digipassInstanceID": "VDS1000001-1",
  "encryptedNotificationID": "0901C3E40F42B8112D690D2E8E11105BD156E89D..."
}

Response

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