digipassActivityQuery (Command)

Mis à jour le 20 Dec 2024
2 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 digipassActivityQuery command allows to query the recent authentication, signature validation, administration, and provisioning activity of a particular authenticator.

Parameters

Table: digipassActivityQuery input parameters (SOAP administration)
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)).
options	DigipassActivityQueryOptions	Optional. Options to determine what results should be returned. See DigipassActivityQueryOptions (Data type).
digipass	DigipassActivityInput	Required. Specifies the authenticator to query recent activities (see DigipassActivityInput (Data type)).

Table: digipassActivityQuery output parameters (SOAP administration)
Parameter name	Data type	Description
errorStack	ErrorStack	Optional. The error stack, indicating that the command has not completed successfully.
resultCodes	ResultCodes	Required. The result and status codes returned by the command.
resultCount	Integer	Required. The number of items in digipassActivityList.
digipassActivityList	DigipassActivityList	Optional. A list containing the queried authenticator activities (see DigipassActivityList (Data type)).

DigipassActivityInput (Data type)

Table: DigipassActivityInput (Data type)
Element name	Data type	Description
serialNumber	String	The serial number of the authenticator to query.

DigipassActivityQueryOptions (Data type)

Table: DigipassActivityQueryOptions (Data type)
Element name	Data type	Description
rowOffset	Unsigned Integer	Optional. Option to request OneSpan Authentication Server to return result records starting from the specified offset. Can only be used together with rowCount. Default value: 0
rowCount	Unsigned Integer	Optional. Option to request OneSpan Authentication Server to return the specified number of result records, beginning with the record specified by rowOffset. If set to 0, all result records are returned. Default value: 0
countOnly	Boolean	Optional. Flag to request OneSpan Authentication Server to return only the number of records in the result set, but not the result set itself. Default value: false
sortOrder	DigipassActivitySortOrder	Optional. Determines the sort order of the result set. By default, the result set is not sorted (see DigipassActivitySortOrder (Data type)).

DigipassActivitySortOrder (Data type)

Table: DigipassActivitySortOrder (Data type)
Element name	Data type	Description
name	DigipassActivitySortOrderFieldEnum	Determines the field attribute to use as key to sort the result set. Possible values: category clientLocation code policyID timestamp
order	SortOrderEnum	Determines the sort order of the result set. Possible values: ASC. Result set in ascending order. DESC. Result set in descending order.

DigipassActivityList (Data type)

Table: DigipassActivityList (Data type)
Element name	Data type	Description
activity	DigipassActivity	A list containing the queried authenticator activities.

Table: DigipassActivity (Data type)
Element name	Returned?	Description
AMID	Always	The audit message identifier.
auditLocation	Always	The location of the component that audited the message. Typically an IP address.
category	Always	The audit category.
clientLocation	Optional	The location of the client component that triggered the audit message. Typically an IP address.
clientType	Optional	The client component type.
code	Always	The audit message code.
description	Always	The description of the audit message.
policyID	Optional	The policy related to the audit message.
reason	Optional	A textual description why the message was audited.
source	Always	The string representation of the source of the audit message.
timestamp	Always	The time when the audit message was recorded.
type	Always	The type of the audit message. Possible values: Error Failure Information Invalid Type Success Warning

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
  <soapenv:Header/>
  <soapenv:Body>
    <adm:digipassActivityQueryRequest>
      <sessionID>bbhDR7=mI90R+Q1Kr_??~9IesbmtnVyQ</sessionID>
      <options>
        <rowOffset>0</rowOffset>
        <rowCount>100</rowCount>
        <countOnly>false</countOnly>
        <sortOrder name="timestamp" order="ASC"/>
      </options>
      <digipass>
        <serialNumber>12-3456789-0</serialNumber>
      </digipass>
    </adm:digipassActivityQueryRequest>
  </soapenv:Body>
</soapenv:Envelope>

Requirements

Required administration privileges:

View Recent DIGIPASS Activity

Additional references

For more information about accepted recent authenticator activities, refer to the OneSpan Authentication Server Product Guide, Section "User Dashboard".

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

What's Next

userActivityQuery (Command)

Table des matières

Parameters
Example
Requirements
Additional references