adminSessionQuery (Command)

Mis à jour le 16 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 adminSessionQuery command allows to query administrative sessions that match specified search criteria.

Parameters

Table: adminSessionQuery 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)).
attributeSet	AdminSessionAttributeSet	Required. Specifies the administrative session query search criteria (will be ignored for this query).
fieldSet	AdminSessionFieldSet	Optional. Specifies the attribute fields to be returned for all the records matching the search criteria. See AdminSessionFieldSet (Data type). If fieldSet is omitted, all possible output parameters are returned. If a administrative session attribute field is not set in the database, it is not returned for that specific administrative session.
queryOptions	AdminSessionQueryOptions	Optional. Options to determine what results should be returned. See AdminSessionQueryOptions (Data type).

AdminSessionAttributeSet (Data type)

The attributes specified in this attribute set define the search criteria.

Search attribute fields are interpreted as follows:

A wildcard character (*) can be added to the values at the start, the end, or both. They will be interpreted as the SQL LIKE statement.
A list of comma-separated values can be specified for the attribute that specifies the domain name. In this case it will be interpreted as the logical OR of the given values.
You cannot use wildcard characters in comma-separated values.
If none of the above applies, the search will be done using the exact match of the given value.

Table: AdminSessionAttributeSet (Data type)
Element name	Data type	Description
attributes	AdminSessionAttribute	Attributes specifying the administrative session query search criteria (see Table: AdminSessionAttribute (Data type)).

Table: AdminSessionAttribute (Data type)
Element name	Data type	Description
attributeOptions	AttributeOptions	Specifies how to handle the attribute value during request processing, where each option is added as a single element to attributeOptions, e.g.: <negative>true</negative> Supported values: negative. Indicates that the specified user attribute value should not be equal to the one specified. null. Indicates that the specified attribute should be handled as zero-value.
value	Any	The attribute value. The data type has to be specified by setting the xsi:type XML attribute.
attributeID	AdminSessionAttributeIDEnum	The attribute identifier (see Table: adminSessionQuery input parameters (SOAP administration)).

Table: adminSessionQuery (Supported input attributes)
Attribute name	Returned?
ADMINSESSIONFLD_DOMAIN	Optional
ADMINSESSIONFLD_LOCATION	Optional
ADMINSESSIONFLD_LOGIN_NAME	Optional
ADMINSESSIONFLD_SESSION_IDX	Optional
ADMINSESSIONFLD_START_TIME	Optional

AdminSessionFieldSet (Data type)

The attributes specified in the fieldSet parameter specify the administrative session attribute fields the OneSpan Authentication Server should return for the administrative sessions matching the search criteria.

If fieldSet is omitted, all possible output parameters are returned. If an attribute field is not set in the database, it is not returned for that specific record.

Table: AdminSessionFieldSet (Data type)
Element name	Data type	Description
attributeID	AdminSessionAttributeIDEnum	The identifier of an attribute to return (see Table: adminSessionQuery (Supported input attributes)).

Table: adminSessionQuery (Supported output attributes)
Attribute name	Returned?
ADMINSESSIONFLD_SESSION_IDX	If defined
ADMINSESSIONFLD_LOCATION	If defined
ADMINSESSIONFLD_LOGIN_NAME	If defined
ADMINSESSIONFLD_START_TIME	If defined

AdminSessionQueryOptions (Data type)

This determines what results should be returned.

Table: AdminSessionQueryResults (Data type)
Element name	Data type	Description
rowcount	Unsigned Integer	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
rowoffset	Unsigned Integer	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

AdminSessionQueryResults (Data type)

Table: AdminSessionQueryResults (Data type)
Element name	Data type	Description
resultCodes	ResultCodes	Required. The result and status codes returned by the command.
resultAttribute	AdminSessionAttributeList	Required. List containing the queried administrative session attributes. Each item is of type AdminSessionAttributeSet.
resultCount	Integer	Required. The number of items in resultAttribute.
errorStack	ErrorStack	Required. The error stack, indicating that the command has not completed successfully.

Requirements

Required administrative privileges:

View Admin Session

Additional considerations

After upgrading OneSpan Authentication Server, server data is continuously migrated while the already-upgraded OneSpan Authentication Server service is running. Until data migration has been completed, the result of a query command may be incomplete and may include both migrated and non-migrated data. This means that values for new data fields may be missing or not set correctly in the query result.

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

What's Next

userExecute (Command)

Table des matières

Parameters
Requirements
Additional considerations