The offlinedataExecute command performs administrative operations–related to offline authentication data (OAD).
Table: offlinedataExecute commands (SOAP administration) | Command | Description |
|---|
OFFLINEDATACMD_DELETE | Deletes offline authentication data records (see OFFLINEDATACMD_DELETE). |
OFFLINEDATACMD_VIEW | Returns offline authentication data information (see OFFLINEDATACMD_VIEW). |
Parameters
Table: offlinedataExecute 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: offlinedataExecute commands (SOAP administration). |
attributeSet | OfflineDataAttributeSet | Required. A set containing zero or more attribute fields. |
Table: offlinedataExecute output parameters | Parameter name | Data type | Description |
|---|
results | OfflineDataResults | 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: offlinedataExecute field attributes | Attribute name | Data type | Description |
|---|
| OFFLINEDATAFLD_APPLNAME | String | The authenticator application used to generate the offline authentication data. OneSpan Authentication Server earlier than 3.14 did not set this attribute, so it might not be included in view/query results after an upgrade. |
| OFFLINEDATAFLD_COMPONENT_LOCATION | String | The client location for which the offline authentication data was created. |
| OFFLINEDATAFLD_COMPONENT_TYPE | String | The component type of the client. |
| OFFLINEDATAFLD_CREATE_TIME | DateTime | The date and time the record was created in the database. |
| OFFLINEDATAFLD_DOMAIN | String | Up to 255 characters. |
| OFFLINEDATAFLD_END_TIME | String | The end time of the offline authentication data block. Offline authentication is not possible after this time has been reached. |
| OFFLINEDATAFLD_EVENT_COUNTER | String | The event counter value. |
| OFFLINEDATAFLD_EVENT_WINDOW | String | The event counter window. |
| OFFLINEDATAFLD_MODIFY_TIME | DateTime | The date and time the record was last modified. |
| OFFLINEDATAFLD_PROTOCOL_ID | String | Specifies which protocol the request uses so that protocol-specific data can be used when appropriate. |
| OFFLINEDATAFLD_SERIALNO | String | The serial number of the authenticator used to generate the offline authentication data. |
| OFFLINEDATAFLD_START_TIME | String | The start time of the offline authentication data block. Offline authentication is not possible until this time has been reached. |
| OFFLINEDATAFLD_USERID | String | The user ID as provided by the calling application (no specific format is required). Up to 255 characters. |
OFFLINEDATACMD_DELETE
OFFLINEDATACMD_DELETE deletes offline authentication data records.
Parameters
The following attributes can be specified in the attributeSet input parameter of this command:
Table: OFFLINEDATACMD_DELETE (Supported input attributes) | Attribute name | Optionality |
|---|
| OFFLINEDATAFLD_COMPONENT_LOCATION | Mandatory |
| OFFLINEDATAFLD_COMPONENT_TYPE | Mandatory |
| OFFLINEDATAFLD_DOMAIN | Mandatory |
| OFFLINEDATAFLD_SERIALNO | Mandatory |
| OFFLINEDATAFLD_USERID | Mandatory |
This command returns no result attributes.
Requirements
Required administrative privileges:
- Reset Offline Authentication Data
OFFLINEDATACMD_VIEW
OFFLINEDATACMD_VIEW returns offline authentication data-related information.
Parameters
The following attributes can be specified in the attributeSet input parameter of this command:
Table: OFFLINEDATACMD_VIEW (Supported input attributes) | Attribute name | Optionality |
|---|
| OFFLINEDATAFLD_COMPONENT_LOCATION | Mandatory |
| OFFLINEDATAFLD_COMPONENT_TYPE | Mandatory |
| OFFLINEDATAFLD_DOMAIN | Mandatory |
| OFFLINEDATAFLD_SERIALNO | Mandatory |
| OFFLINEDATAFLD_USERID | Mandatory |
The following attributes will be specified in the results output parameter of this command:
Table: OFFLINEDATACMD_VIEW (Supported output attributes) | Attribute name | Returned? |
|---|
| OFFLINEDATAFLD_APPL_NAME | Always |
| OFFLINEDATAFLD_COMPONENT_LOCATION | Always |
| OFFLINEDATAFLD_COMPONENT_TYPE | Always |
| OFFLINEDATAFLD_CREATE_TIME | Always |
| OFFLINEDATAFLD_DOMAIN | Always |
| OFFLINEDATAFLD_END_TIME | If defined |
| OFFLINEDATAFLD_EVENT_COUNTER | Always |
| OFFLINEDATAFLD_EVENT_WINDOW | Always |
| OFFLINEDATAFLD_MODIFY_TIME | Always |
| OFFLINEDATAFLD_SERIALNO | Always |
| OFFLINEDATAFLD_START_TIME | If defined |
| OFFLINEDATAFLD_USERID | Always |
Requirements
Required administrative privileges: