digipassapplExecute (Command)

18 Dec 2024
13 Minutes à lire

Partager
Sombre
Lumière
PDF

digipassapplExecute (Command)

Mis à jour le 18 Dec 2024
13 Minutes à lire

Partager
Sombre
Lumière
PDF

The content is currently unavailable in French. You are viewing the default English version.

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

The digipassapplExecute command performs administrative operations for authenticator applications.

Table: digipassapplExecute commands (SOAP administration)
Command	Description
DIGIPASSAPPLCMD_CREATE	Creates a new authenticator application (see DIGIPASSAPPLCMD_CREATE).
DIGIPASSAPPLCMD_CREATE_EMVCAP	Generates an authenticator record for an EMV-CAP card reader (see DIGIPASSAPPLCMD_CREATE_EMVCAP).
DIGIPASSAPPLCMD_DELETE	Deletes the specified authenticator application (see DIGIPASSAPPLCMD_DELETE).
DIGIPASSAPPLCMD_DISABLE_PIN	Disables the server PIN for the specified authenticator application (see DIGIPASSAPPLCMD_DISABLE_PIN).
DIGIPASSAPPLCMD_ENABLE_PIN	Enables the server PIN for the specified authenticator application (see DIGIPASSAPPLCMD_ENABLE_PIN).
DIGIPASSAPPLCMD_FORCE_PIN_CHANGE	Updates the specified authenticator application to force a PIN change at next application usage (see DIGIPASSAPPLCMD_FORCE_PIN_CHANGE).
DIGIPASSAPPLCMD_GEN_VOTP	Generates and sends a valid OTP to a mobile phone or email address via the Message Delivery Component (MDC) configured in OneSpan Authentication Server (see DIGIPASSAPPLCMD_GEN_VOTP).
DIGIPASSAPPLCMD_GENERATE_ACTIVATION_DATA	Generates activation data for Mobile Authenticator Studio (see DIGIPASSAPPLCMD_GENERATE_ACTIVATION_DATA).
DIGIPASSAPPLCMD_GETINFO	Returns the application information for the specified authenticator application (see DIGIPASSAPPLCMD_GETINFO).
DIGIPASSAPPLCMD_RESET_APPL	Resets the specified authenticator application (see DIGIPASSAPPLCMD_RESET_APPL).
DIGIPASSAPPLCMD_RESET_ERROR_COUNT	Resets the error count for the specified authenticator application (see DIGIPASSAPPLCMD_RESET_ERROR_COUNT).
DIGIPASSAPPLCMD_RESET_PIN	Resets the server PIN for the specified authenticator application (see DIGIPASSAPPLCMD_RESET_PIN).
DIGIPASSAPPLCMD_SET_EVENT_COUNTER	Sets the event counter for the specified authenticator application (see DIGIPASSAPPLCMD_SET_EVENT_COUNTER).
DIGIPASSAPPLCMD_SET_PIN	Sets the server PIN for the specified authenticator application (see DIGIPASSAPPLCMD_SET_PIN).
DIGIPASSAPPLCMD_TEST_EMVCAP_MODE1	Tests the EMV-CAP Mode 1 for a specific authenticator application smart card reader (see DIGIPASSAPPLCMD_TEST_EMVCAP_MODE1).
DIGIPASSAPPLCMD_TEST_EMVCAP_MODE2	Tests the EMV-CAP Mode 2 for a specific authenticator application smart card reader (see DIGIPASSAPPLCMD_TEST_EMVCAP_MODE2).
DIGIPASSAPPLCMD_TEST_EMVCAP_MODE3	Tests the EMV-CAP Mode 3 for a specific authenticator application smart card reader (see DIGIPASSAPPLCMD_TEST_EMVCAP_MODE3).
DIGIPASSAPPLCMD_TEST_OTP	Tests validation of an OTP for a specified authenticator application (see DIGIPASSAPPLCMD_TEST_OTP).
DIGIPASSAPPLCMD_TEST_SIGNATURE	Performs a signature validation test for the specified authenticator application (see DIGIPASSAPPLCMD_TEST_SIGNATURE).
DIGIPASSAPPLCMD_UNLOCK	Unlocks the specified authenticator application (see DIGIPASSAPPLCMD_UNLOCK).
DIGIPASSAPPLCMD_UPDATE	Modifies the specified authenticator application (see DIGIPASSAPPLCMD_UPDATE).
DIGIPASSAPPLCMD_VIEW	Displays the application information for a specified authenticator application (see DIGIPASSAPPLCMD_VIEW).

Parameters

Table: digipassapplExecute input parameters
Parameter name	Data type	Description
sessionID	String	Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)).
cmd	String	Required. The operation to be executed. See Table: digipassapplExecute commands (SOAP administration).
attributeSet	DigipassApplAttributeSet	Required. A set containing zero or more attribute fields. See Table: digipassapplExecute field attributes.

Table: digipassapplExecute output parameters
Parameter name	Data type	Description
results	DigipassApplResults	Required. Result structure containing return and status codes and a list of zero or more result attribute fields.

The following field attributes are available for the operations of this command:

Table: digipassapplExecute field attributes
Attribute name	Data type	Description
DIGIPASSAPPLFLD_ACTIVE	Boolean	Indicates whether the authenticator application is active.
DIGIPASSAPPLFLD_APPL_NAME	String	The authenticator application name. Up to 12 characters.
DIGIPASSAPPLFLD_APPL_NO	Integer	A sequence number assigned during import, which should be unique per authenticator.
DIGIPASSAPPLFLD_APPL_TYPE	String	The type of the authenticator application. Supported values: RO CR SG MM UL MA
DIGIPASSAPPLFLD_BLOB	String	The authenticator application BLOB. Exactly 248 characters.
DIGIPASSAPPLFLD_CARD_AID	String	EMV-CAP application identifier ASCII hex value.
DIGIPASSAPPLFLD_CARD_AIP	String	EMV-CAP application interchange protocol ASCII hex value.
DIGIPASSAPPLFLD_CARD_ATC	String	EMV-CAP application transaction counter ASCII hex value
DIGIPASSAPPLFLD_CARD_CARDDATA	String	EMV-CAP card data ASCII hex value
DIGIPASSAPPLFLD_CARD_CDOL1	String	EMV-CAP card risk management data object list ASCII hex value
DIGIPASSAPPLFLD_CARD_CID	String	EMV-CAP cryptogram information data ASCII hex value
DIGIPASSAPPLFLD_CARD_IAD	String	EMV-CAP issuer application data ASCII hex value
DIGIPASSAPPLFLD_CARD_IAF	String	EMV-CAP Internet authentication flags ASCII hex value
DIGIPASSAPPLFLD_CARD_IIPB	String	EMV-CAP issuer Internet proprietary bitmap ASCII hex value
DIGIPASSAPPLFLD_CHALLENGE	String	The challenge generated by an authenticator application supporting a Challenge/Response scheme.
DIGIPASSAPPLFLD_CONFIRM_CODE		The host code, which can be used by the client to validate that the command was executed by the correct server. Only returned if requested in the input and the command execution was successful. Up to 17 numeric or hexadecimal characters.
DIGIPASSAPPLFLD_CREATE_TIME	DateTime	The date and time the data record was created.
DIGIPASSAPPLFLD_DATA_FIELD_1	String	The signature data fields (limited by the authenticator application, maximum 8) used to generate the electronic signature. Components of the transaction data to be used in the digital signature. Used in Mode 2 (Digital Signature) only.
DIGIPASSAPPLFLD_DATA_FIELD_2	String
DIGIPASSAPPLFLD_DATA_FIELD_3	String
DIGIPASSAPPLFLD_DATA_FIELD_4	String
DIGIPASSAPPLFLD_DATA_FIELD_5	String
DIGIPASSAPPLFLD_DATA_FIELD_6	String
DIGIPASSAPPLFLD_DATA_FIELD_7	String
DIGIPASSAPPLFLD_DATA_FIELD_8	String
DIGIPASSAPPLFLD_DATA_FIELD_9	String
DIGIPASSAPPLFLD_DATA_FIELD_10	String
DIGIPASSAPPLFLD_DEFERRED_DATETIME	DateTime	The deferred signature datetime attribute should be specified in a full date/time format.
DIGIPASSAPPLFLD_DEFERRED_EVENT_VALUE	Integer	The deferred event counter of the authenticator application used to generate a signature.
DIGIPASSAPPLFLD_DELIVERY_METHOD	String	The method used to deliver the Virtual Mobile Authenticator to the selected user: Default. Use the settings of the parent policy. Email. Deliver the OTP via email. The user account must have an email address configured. SMS. Deliver the OTP via SMS. The user account must have a mobile phone number configured. Voice. Deliver the OTP via voice channel (i.e. dictated over a phone line). The user account must have a mobile phone number configured.
DIGIPASSAPPLFLD_DESTINATION
DIGIPASSAPPLFLD_DIRECT_ASSIGN_ONLY
DIGIPASSAPPLFLD_DOMAIN	String	Domain containing the authenticator. As input: If domain is required but not specified, the default domain (master) will be used. Up to 255 characters.
DIGIPASSAPPLFLD_DPSOFT_PARAMS_ID
DIGIPASSAPPLFLD_DPTYPE	String	The type of the authenticator.
DIGIPASSAPPLFLD_EMAIL	String	The email address of the user. Up to 63 characters.
DIGIPASSAPPLFLD_EMV_TYPE	String	EMV-CAP scheme type as defined by OneSpan Authentication Server Framework. ASCII hex value
DIGIPASSAPPLFLD_EVENT_COUNTER	String	The event counter for the authenticator application. This parameter is used to synchronize the authenticator event counter between the authenticator and OneSpan Authentication Server.
DIGIPASSAPPLFLD_EVENT_REACTIVATION_COUNTER	String	This is the encrypted event reactivation counter returned to the user during reactivation. This parameter will be returned if an authenticator is already registered, but has an event counter larger than 0. This parameter contains either the event reactivation counter (ERC) (in case of offline mode) or the encrypted event reactivation counter (XERC) (in case of online mode).
DIGIPASSAPPLFLD_FULL_ACTIVATION_DATA	String	The activation code encapsulated in an XML envelope. The parameter is returned to the user to activate a software authenticator.
DIGIPASSAPPLFLD_HOST_CODE	String	The host code returned by the OneSpan Authentication Server Framework library.
DIGIPASSAPPLFLD_KEY_KCV	String	The key check value of a hardware security module (HSM) key label. ASCII hex value
DIGIPASSAPPLFLD_KEY_LABEL	String	The hardware security module (HSM) key label. ASCII hex value
DIGIPASSAPPLFLD_LDAP_DN	String	LDAP distinguished name
DIGIPASSAPPLFLD_MDC_PROFILE	String	The specific MDC profile used to send a virtual one-time password (OTP) via the Message Delivery Component (MDC). This takes precedence over the MDC profile specified in the user profile. Can be a null-value (via attributeOptions).
DIGIPASSAPPLFLD_MOBILE	String	The mobile number of the user. Must contain a phone number that consists of numbers, spaces, and brackets () {} [] only. There may also be a plus sign '+' at the beginning of the number. Up to 20 characters.
DIGIPASSAPPLFLD_MODIFY_TIME	DateTime	The date and time the data record was last modified.
DIGIPASSAPPLFLD_NEW_PIN	String	The new authenticator application PIN when setting a new PIN.
DIGIPASSAPPLFLD_NEW_PIN_CONF	String	The confirmation of the new authenticator application PIN when setting a new PIN.
DIGIPASSAPPLFLD_REQUEST_KEY	String	The key that refers to a request message cached by OneSpan Authentication Server. Applies if Secure Channel is supported.
DIGIPASSAPPLFLD_RESPONSE	String	The response for a challenge by an authenticator application that supports a Challenge/Response scheme.
DIGIPASSAPPLFLD_RESULT_CODE	String	The corresponding error code to DIGIPASSAPPLFLD_RESULT_MESSAGE.
DIGIPASSAPPLFLD_RESULT_MESSAGE	String	The error message if a validation has failed.
DIGIPASSAPPLFLD_SECURE_CHANNEL_SUPPORT	Boolean	Determines whether the authenticator application supports Secure Channel. Supported values: True False
DIGIPASSAPPLFLD_SERNO	String	Exactly 10 characters.
DIGIPASSAPPLFLD_SIGNATURE	String	The electronic signature. Up to 17 numeric or hexadecimal characters.
DIGIPASSAPPLFLD_SYNCHRONISE	String	Flag that indicates if the application created should overwrite existing ones.
DIGIPASSAPPLFLD_TRANSACTION_AMOUNT	String	The currency amount of the submitted transaction.
DIGIPASSAPPLFLD_TRANSACTION_CURRENCY	String	The currency used in the transaction specified as ISO 4217 numeric currency code (refer to http://en.wikipedia.org/wiki/ISO_4217#Active_codes). Up to 4 characters.
DIGIPASSAPPLFLD_UNLOCK_CHAL	String	When unlocking an authenticator an unlock challenge will be generated when the authenticator is turned on again after it has been locked.
DIGIPASSAPPLFLD_UNLOCK_CODE	String	The challenge code has to be inserted to generate an unlock code from OneSpan Authentication Server to unlock an authenticator.
DIGIPASSAPPLFLD_VERIFIED_DATETIME	DateTime	Applicable to time-based signature validation applications. Returned if the used authenticator has the time-based algorithm enabled for the signature application and if online signature mode is enabled in the effective policy.
DIGIPASSAPPLFLD_VERIFIED_EVENT_VALUE	Integer	Applicable to event-based signature validation applications.

DIGIPASSAPPLCMD_CREATE

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_CREATE (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_ACTIVE	Mandatory
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_APPL_NO	Mandatory
DIGIPASSAPPLFLD_APPL_TYPE	Mandatory
DIGIPASSAPPLFLD_BLOB	Mandatory
DIGIPASSAPPLFLD_DPTYPE	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_CREATE (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_VIEW

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_VIEW (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_VIEW (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_BLOB	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_DOMAIN	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SECURE_CHANNEL_SUPPORT	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_UPDATE

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_UPDATE (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_ACTIVE	Mandatory
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_UPDATE (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_BLOB	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_DOMAIN	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_DELETE

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_DELETE (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

This command returns no result attributes.

DIGIPASSAPPLCMD_TEST_OTP

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_OTP (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_REQUEST_HOST_CODE	Optional
DIGIPASSAPPLFLD_RESPONSE	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_OTP (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_RESULT_CODE	Always
DIGIPASSAPPLFLD_HOST_CODE	Always
DIGIPASSAPPLFLD_RESULT_MESSAGE	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_RESET_APPL

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_RESET_APPL (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_RESET_APPL (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_RESET_PIN

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_RESET_PIN (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_RESET_PIN (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_SET_PIN

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_SET_PIN (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_NEW_PIN	Mandatory
DIGIPASSAPPLFLD_NEW_PIN_CONF	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_SET_PIN (Supported output attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

DIGIPASSAPPLCMD_ENABLE_PIN

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_ENABLE_PIN (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

DIGIPASSAPPLCMD_DISABLE_PIN

This command disables the server PIN for the specified authenticator application.

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_DISABLE_PIN (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_DISABLE_PIN (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_DOMAIN_NAME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_UNLOCK

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_UNLOCK (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory
DIGIPASSAPPLFLD_UNLOCK_CHAL	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_UNLOCK (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_SERNO	Always
DIGIPASSAPPLFLD_UNLOCK_CODE	Always

DIGIPASSAPPLCMD_GETINFO

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_GETINFO (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_GETINFO (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

The SOAP response of DIGIPASSAPPLCMD_GETINFO contains a result infoset XML element, i.e. DIGIPASSAPPL-TYPES:DigipassApplDPInfoItem. This XML element lists the authenticator application information.

Table: DIGIPASSAPPL-TYPES:DigipassApplDPInfoItem list items
Item name	Data type	Description
Amount Supported	Boolean	Applies only to EMV-CAP (TokenType= DPEMV), and only if a Thales ProtectServer HSM is used. Indicates whether the authenticator application supports the use of the transaction amount data for validation. Possible values: Yes No
Code Word	String	The application code word. It provides information about the algorithm used by the authenticator application. 8 hexadecimal characters
Current Event Value	UINT32	Applicable for event-based algorithms to specify the current event value stored in the authenticator application BLOB. This value indicates the greatest event value that has been received for a valid verification, not necessarily of the latest valid verification performed (for non-sequential signature presentation). Possible values: 10 digits, 0000000000–4294967294
Error Count	UINT32	The error counter value (3 digits).
Event Based Algorithm	Boolean	Indicates whether the authenticator application has an event-based algorithm. Possible values: Yes No
IMK Label	String	Applies only to EMV-CAP (TokenType= DPEMV), and only if Thales ProtectServer HSM is used. The label of the EMV-CAP issuer master key (IMK) used by the authenticator application. Up to 15 characters.
KCV Type	String	Applies only to EMV-CAP (TokenType= DPEMV), and only if Thales ProtectServer HSM is used. Up to 8 characters.
Last Response Type	String	The last valid response type. Possible values: PRIMARY BACKUP Up to 8 characters.
Last Time Shift	INT32	The shift between the host and the authenticator clock in seconds. 6 signed digits, +/- seconds
Last Time Used	DATETIME	The date and time of the last successful authentication. Format: YYYY/MM/DD HH:MM:SS
Last Verification Event Value	UINT32	Applicable for event-based algorithms to specify the event value of the last valid verification (used for non-sequential signature presentation). Possible values: 10 digits, 0000000000–4294967294
Maximum Input Fields	UINT32	The maximum number of challenges or data fields (1 digit). Possible values: 0–8
PIN Change Forced	Boolean	Indicates whether the server PIN has to be changed at the next logon attempt. Possible values: Yes No
PIN Change On	Boolean	Indicates whether the user can change the server PIN. Possible values: Yes No
PIN Enabled	Boolean	Indicates whether the server PIN is enabled. Possible values: Yes No
PIN Length	UINT32	Current length of the server PIN (2 digits). Possible values: 00–08
PIN Minimum Length	UINT32	The allowed minimum length for the server PIN (2 digits). Possible values: 00–08
PIN Supported	Boolean	Indicates whether the authenticator application supports server PINs. Possible values: Yes No
Primary Token Enabled	Boolean	Indicates whether the primary authenticator is enabled. Possible values: Yes No
Response Checksum	Boolean	Indicates whether the response contains a checksum value. Possible values: Yes No
Response Length	UINT32	The length of the response (2 digits). Possible values: 02–16
Response Type	String	The type of response (3 characters). Possible types: DEC. Decimal response. HEX. Hexadecimal response.
Sync Window Reset	Boolean	Indicates whether the initial synchronization window will be used to perform the next validation for this authenticator instance. Possible values: Yes No
Time Based Algorithm	Boolean	Indicates whether the authenticator application has a time-based algorithm. Possible values: Yes No
Time Step Used	UINT32	Decimal value of the time step in seconds for time-based applications (6 digits). Possible values: 000000–262144
Token Model	String	The type of authenticator, e.g. Digipass 300, Digipass 700, etc. 5 characters.
Triple DES	Boolean	Indicates if the application uses the Triple DES (3DES) algorithm. Possible values: Yes No
Unlock Supported	Boolean	Indicates whether the authenticator application supports unlock. Possible values: Yes No
Use Count	UINT32	The number of successful authentications, capped to a maximum number if the authenticator is used more than a defined number of times (6 digits). Possible values: 000000–032767 for EMV-CAP authenticators. 000000–999999 for other types of authenticators.
Virtual Token Enabled	Boolean	Indicates whether virtual authenticator is enabled. Possible values: Yes No
Virtual Token Grace Period Expiry Date	String	Indicates the date and time when the virtual authenticator expires (24 characters). Day of the week - Ddd Month - Mmm Day - DD Hour - HH Minute - MM Seconds - SS Year - YYYY Format: Ddd Mmm DD HH:MM:SS YYYY
Virtual Token Remaining Use Count	UINT32	The remaining times the virtual authenticator can be used (3 digits). Possible values: 000–255
Virtual Token Supported	Boolean	Indicates whether the use of a virtual authenticator is supported. Possible values: Yes No
Virtual Token Type	String	Indicates which type of virtual authenticator is supported. Possible values: PRIMARY BACKUP NA Up to 7 characters

DIGIPASSAPPLCMD_GEN_VOTP

This command generates a one-time password (OTP) for the specified authenticator application, and sends it to a mobile phone or email address via the Message Delivery Component (MDC) configured in OneSpan Authentication Server.

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_GEN_VOTP (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_DELIVERY_METHOD	Mandatory
DIGIPASSAPPLFLD_EMAIL	Mandatory if DIGIPASSAPPLFLD_DELIVERY_METHOD = Email
DIGIPASSAPPLFLD_MDC_PROFILE	Optional (see below)
DIGIPASSAPPLFLD_MOBILE	Mandatory if DIGIPASSAPPLFLD_DELIVERY_METHOD = SMS
DIGIPASSAPPLFLD_SERNO	Mandatory

If DIGIPASSAPPLFLD_MDC_PROFILE is not specified, DIGIPASSAPPLCMD_GEN_VOTP uses the MDC profile specified in the user profile. If the user profile has no explicit MDC profile specified, the MDC profile specified in the effective policy is used (effective for the administrator currently logged on). If the effective policy has no explicit MDC profile specified, MDC uses the default MDC profile order as configured in the MDC configuration.

If DIGIPASSAPPLFLD_MDC_PROFILE is specified as null-value using attributeOptions (see Table: DigipassApplAttribute (Data type)), the default MDC profile order as configured in the MDC configuration is used. In this case, any MDC profile settings specified in the user profile or the effective policy are ignored.

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_GEN_VOTP (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_RESULT_CODE	Always
DIGIPASSAPPLFLD_RESULT_MESSAGE	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_FORCE_PIN_CHANGE

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_FORCE_PIN_CHANGE (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_FORCE_PIN_CHANGE (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_SET_EVENT_COUNTER

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_SET_EVENT_COUNTER (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_EVENT_COUNTER	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_SET_EVENT_COUNTER (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_RESET_ERROR_COUNT

This command resets the error count for the specified authenticator application. If the authenticator application has been locked, the DIGIPASSAPPLCMD_UNLOCK command will be needed to unlock it.

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_RESET_ERROR_COUNT (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_RESET_ERROR_COUNT (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_ACTIVE	Always
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CREATE_TIME	Always
DIGIPASSAPPLFLD_MODIFY_TIME	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_TEST_SIGNATURE

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_SIGNATURE (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_DOMAIN	Optional
DIGIPASSAPPLFLD_DATA_FIELD_1	Mandatory
DIGIPASSAPPLFLD_DATA_FIELD_2	Optional
DIGIPASSAPPLFLD_DATA_FIELD_3	Optional
DIGIPASSAPPLFLD_DATA_FIELD_4	Optional
DIGIPASSAPPLFLD_DATA_FIELD_5	Optional
DIGIPASSAPPLFLD_DATA_FIELD_6	Optional
DIGIPASSAPPLFLD_DATA_FIELD_7	Optional
DIGIPASSAPPLFLD_DATA_FIELD_8	Optional
DIGIPASSAPPLFLD_DEFERRED_DATE_TIME	Optional
DIGIPASSAPPLFLD_DEFERRED_EVENT_VALUE	Optional
DIGIPASSAPPLFLD_REQUEST_CONFIRM_CODE	Optional
DIGIPASSAPPLFLD_REQUEST_KEY	Optional
DIGIPASSAPPLFLD_SERNO	Mandatory
DIGIPASSAPPLFLD_SIGNATURE	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_SIGNATURE (Supported output attributes)
Attribute name	Returned?	Remarks
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_APPL_NO	Always
DIGIPASSAPPLFLD_APPL_TYPE	Always
DIGIPASSAPPLFLD_CONFIRM_CODE	Optional	If DIGIPASSAPPLCMD_REQUEST_CONFIRM_CODE has been specified in the input and was set to either Required or Optional.
DIGIPASSAPPLFLD_DOMAIN	Always
DIGIPASSAPPLFLD_ORGANIZATIONAL_UNIT	Optional
DIGIPASSAPPLFLD_RESULT_CODE	Always
DIGIPASSAPPLFLD_RESULT_MESSAGE	Always
DIGIPASSAPPLFLD_SERNO	Always
DIGIPASSAPPLFLD_VERIFIED_DATE_TIME	Optional	In case of a time-based signature application.
DIGIPASSAPPLFLD_VERIFIED_EVENT_VALUE	Optional	In case of an event-based signature application.

DIGIPASSAPPLCMD_TEST_EMVCAP_MODE1

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_EMVCAP_MODE1 (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_CHALLENGE	Optional
DIGIPASSAPPLFLD_DOMAIN	Optional
DIGIPASSAPPLFLD_RESPONSE	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory
DIGIPASSAPPLFLD_TRANSACTION_AMOUNT	Optional
DIGIPASSAPPLFLD_TRANSACTION_CURRENCY	Optional

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_EMVCAP_MODE1 (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_DOMAIN	Always
DIGIPASSAPPLFLD_RESULT_CODE	Always
DIGIPASSAPPLFLD_RESULT_MESSAGE	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_TEST_EMVCAP_MODE2

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_EMVCAP_MODE2 (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_DATA_FIELD_1	Mandatory
DIGIPASSAPPLFLD_DATA_FIELD_2	Optional
DIGIPASSAPPLFLD_DATA_FIELD_3	Optional
DIGIPASSAPPLFLD_DATA_FIELD_4	Optional
DIGIPASSAPPLFLD_DATA_FIELD_5	Optional
DIGIPASSAPPLFLD_DATA_FIELD_6	Optional
DIGIPASSAPPLFLD_DATA_FIELD_7	Optional
DIGIPASSAPPLFLD_DATA_FIELD_8	Optional
DIGIPASSAPPLFLD_DATA_FIELD_9	Optional
DIGIPASSAPPLFLD_DATA_FIELD_10	Optional
DIGIPASSAPPLFLD_DOMAIN	Optional
DIGIPASSAPPLFLD_RESPONSE	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_EMVCAP_MODE2 (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_DOMAIN	Always
DIGIPASSAPPLFLD_RESULT_CODE	Always
DIGIPASSAPPLFLD_RESULT_MESSAGE	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_TEST_EMVCAP_MODE3

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_EMVCAP_MODE3 (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_CHALLENGE	Mandatory
DIGIPASSAPPLFLD_DOMAIN	Optional
DIGIPASSAPPLFLD_RESPONSE	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_TEST_EMVCAP_MODE3 (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_APPL_NAME	Always
DIGIPASSAPPLFLD_DOMAIN	Always
DIGIPASSAPPLFLD_RESULT_CODE	Always
DIGIPASSAPPLFLD_RESULT_MESSAGE	Always
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_CREATE_EMVCAP

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_CREATE_EMVCAP (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_ACTIVE	Mandatory
DIGIPASSAPPLFLD_CARD_AID	Optional
DIGIPASSAPPLFLD_CARD_AIP	Mandatory
DIGIPASSAPPLFLD_CARD_ATC	Optional
DIGIPASSAPPLFLD_CARD_CARDDATA	Optional
DIGIPASSAPPLFLD_CARD_CDOL1	Optional
DIGIPASSAPPLFLD_CARD_CID	Optional
DIGIPASSAPPLFLD_CARD_IAD	Mandatory
DIGIPASSAPPLFLD_CARD_IAF	Mandatory
DIGIPASSAPPLFLD_CARD_IIPB	Mandatory
DIGIPASSAPPLFLD_DOMAIN	Mandatory
DIGIPASSAPPLFLD_EMV_TYPE	Mandatory
DIGIPASSAPPLFLD_KEY_LABEL	Mandatory
DIGIPASSAPPLFLD_KEY_KCV	Mandatory
DIGIPASSAPPLFLD_ORGANIZATIONAL_UNIT	Optional
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_CREATE_EMVCAP (Supported output attributes)
Attribute name	Returned?	Remarks
DIGIPASSAPPLFLD_ACTIVE
DIGIPASSAPPLFLD_APPL_NAME	Always	Application name will be EMV.
DIGIPASSAPPLFLD_APPL_NO		Application number will be 1.
DIGIPASSAPPLFLD_APPL_TYPE		Application type will be MM.
DIGIPASSAPPLFLD_BLOB
DIGIPASSAPPLFLD_CREATE_TIME
DIGIPASSAPPLFLD_DOMAIN	Always
DIGIPASSAPPLFLD_MODIFY_TIME
DIGIPASSAPPLFLD_SERNO	Always

DIGIPASSAPPLCMD_GENERATE_ACTIVATION_DATA

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DIGIPASSAPPLCMD_GENERATE_ACTIVATION_DATA (Supported input attributes)
Attribute name	Optionality
DIGIPASSAPPLFLD_APPL_NAME	Mandatory
DIGIPASSAPPLFLD_DOMAIN	Mandatory
DIGIPASSAPPLFLD_SERNO	Mandatory

The following attributes will be specified in the results output parameter of this command:

Table: DIGIPASSAPPLCMD_GENERATE_ACTIVATION_DATA (Supported output attributes)
Attribute name	Returned?
DIGIPASSAPPLFLD_FULL_ACTIVATION_DATA	Always
DIGIPASSAPPLFLD_EVENT_REACTIVATION_COUNTER	Always

Cet article vous a-t-il été utile ?

What's Next

digipassapplQuery (Command)