userActivityQuery (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 userActivityQuery command allows to query the recent authentication, signature validation, administration, and provisioning activity of a particular user.

Parameters

Table: userActivityQuery 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	UserActivityQueryOptions	Optional. Options to determine what results should be returned. See UserActivityQueryOptions (Data type).
user	UserActivityInput	Required. Specifies the user to query recent activities (see UserActivityInput (Data type)).

Table: userActivityQuery 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 userActivityList.
userActivityList	UserActivityList	Optional. List containing the queried user activities (see UserActivityList (Data type)).

UserActivityInput (Data type)

Table: UserActivityInput (Data type)
Element name	Data type	Description
userID	String	The ID of the user to query.
domain	String	The domain of the user to query.

UserActivityQueryOptions (Data type)

Table: userActivityQueryOptions (Data type)
Element name	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
filter	UserActivityFilterExpression	Optional. Filter configuration for the result set (see UserActivityFilterExpression (Data type)).
sortOrder	UserActivitySortOrder	Optional. Determines the sort order of the result set. By default, the result set is not sorted (see UserActivitySortOrder (Data type)).

UserActivityFilterExpression (Data type)

Table: UserActivityFilterExpression (Data type)
Element name	Data type	Description
field	UserActivityFilter	A filter expression definition for one particular attribute field.

Table: UserActivityFilter attributes (Data type)
Attribute name	Data type	Description
name	UserActivityFilterFieldEnum	The field attribute to use as key to filter the result set. Possible values: clientType policyID

Table: UserActivityFilter (Data Type)
Element name	Data type	Description
equals	String	Specifies the value to compare with UserActivityFilter.name. Cannot be used with isNotNull.
isNotNull	EmptyType	Verifies that UserActivityFilter.name is not empty. Cannot be used with equals.

UserActivitySortOrder (Data type)

Table: UserActivitySortOrder (Data type)
Element name	Data type	Description
name	UserActivitySortOrderFieldEnum	Determines the field attribute to use as key to sort the result set. Possible values: category clientLocation code policyID serialNumber 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.

UserActivityList (Data type)

Table: UserActivityList (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.
serialNumber	Optional	The serial number of the authenticator related to the audit message.
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:userActivityQueryRequest>
      <sessionID>bbhDR7=mI90R+Q1Kr_??~9IesbmtnVyQ</sessionID>
      <options>
        <rowOffset>0</rowOffset>
        <rowCount>100</rowCount>
        <countOnly>false</countOnly>
        <filter>
          <field name="clientType">
            <isNotNull/>
          </field>
        </filter>
        <sortOrder name="timestamp" order="ASC"/>
      </options>
      <user>
        <userID>jdoe</userID>
        <domain>master</domain>
      </user>
    </adm:userActivityQueryRequest>
  </soapenv:Body>
</soapenv:Envelope>

Requirements

Required administrative privileges:

View Recent User Activity

Additional references

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

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

What's Next

SOAP DIGIPASS import file management

Table des matières

Parameters
Example
Requirements
Additional references