queryPendingOperation (Command)

Mis à jour le 20 Dec 2024
3 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 queryPendingOperation command allows to query a pending operation in the context of maker–checker authorization.

Parameters

Table: queryPendingOperation 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	PendingOperationAttributeSet	Required. A set containing zero or more attribute fields that specify the query search criteria. See PendingOperationAttributeSet (Data type).
fieldSet	PendingOperationFieldSet	Optional. Specifies the attribute fields to be returned for all the records matching the search criteria. See PendingOperationFieldSet (Data type). If fieldSet is omitted, all possible output parameters are returned. If a pending operation attribute field is not set in the database, it is not returned for that specific operation.
queryOptions	PendingOperationQueryOptions	Optional. Options to determine what results should be returned. See PendingOperationQueryOptions (Data type).

Table: queryPendingOperation output parameters (SOAP administration)
Parameter name	Data type	Description
results	queryPendingOperationResults	Required. Result structure containing return and status codes and a list of zero or more result attribute fields. See PendingOperationsQueryResults (Data type).

PendingOperationAttributeSet (Data type)

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

Search fields are interpreted as follows:

The asterisk (*) wildcard can be used for POFLD_CONTEXT, POFLD_IDENTIFIER, and POFLD_SERIAL_NO like in SQL SELECT statements.

Table: PendingOperationAttributeSet (Data type)
Element name	Data type	Description
attributes	PendingOperationAttribute	Attributes specifying the pending operation query search criteria (see Table: PendinOperationAttribute (Data type)).

Table: PendinOperationAttribute (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	PendingOperationAttributeIDEnum	The attribute identifier (see Table: queryPendingOperation (Supported input attributes)).

Table: queryPendingOperation (Supported input attributes)
Attribute name	Optionality
POFLD_AUTO_EXECUTE	Optional
POFLD_CHECKER_DOMAIN	Optional
POFLD_CHECKER_USERID	Optional
POFLD_COMMAND	Optional
POFLD_CONTEXT	Optional
POFLD_CONTEXTID	Optional
POFLD_DOMAIN	Optional
POFLD_IDENTIFIER	Optional
POFLD_MAKER_DOMAIN	Optional
POFLD_MAKER_USERID	Optional
POFLD_OBJECT	Optional
POFLD_SERIAL_NO	Optional
POFLD_STATUS	Optional

PendingOperationFieldSet (Data type)

The attributes specified in the fieldSet parameter specify the pending operations attribute fields that should be returned by OneSpan Authentication Server for the operations 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: PendingOperationFieldSet (Data type)
Element name	Data type	Description
attributeID	PendingOperationAttributeIDEnum	The identifier of an attribute to return (see Table: queryPendingOperation (Supported output attributes) ).

Table: queryPendingOperation (Supported output attributes)
Attribute name	Returned?
POFLD_AUTO_EXECUTE	If defined
POFLD_CHECKER_DOMAIN	If defined
POFLD_CHECKER_USERID	If defined
POFLD_COMMAND	If defined
POFLD_CONTEXTID	If defined
POFLD_CREATE_TIME	If defined
POFLD_DOMAIN	If defined
POFLD_IDENTIFIER	If defined
POFLD_MAKER_DOMAIN	If defined
POFLD_MAKER_USERID	If defined
POFLD_MODIFY_TIME	If defined
POFLD_NOTE	If defined
POFLD_OBJECT	If defined
POFLD_ORGANIZATIONAL_UNIT	If defined
POFLD_SERIAL_NO	If defined
POFLD_STATUS	If defined
POFLD_TO_SERIAL_NO	If defined

The queryPendingOperation command only returns pending operations that are visible in the domain scope of the administrative session.

PendingOperationQueryOptions (Data type)

This data type determines what results should be returned.

Table: QueryOptions (Data type)
Element name	Data type	Description
count	Boolean	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
distinct	Boolean	Flag to request OneSpan Authentication Server to return only unique query results. Default value: false
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
sortfieldid	String	Optional. Required if you specify SortOrder. Determines the field attribute to use as sort key when sorting the result set using SortOrder. May contain any field attribute from the FieldSet parameter.
sortorder	String	Optional. Determines the sort order of the result set. By default, the result set is unsorted. Possible values: QUERYOPTIONSORTORDER_ASCENDING. Result set in ascending order. QUERYOPTIONSORTORDER_DESCENDING. Result set in descending order.

PendingOperationsQueryResults (Data type)

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

Examples

Query a specific pending operation:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <adm:queryPendingOperation xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <sessionID>wo]to7L]ChB^?iH1Bmi3jXUu#-ORG^Mh</sessionID>
      <attributeSet>
        <attributes>
          <value xsi:type="xsd:string">0a0ac84b5aec11e21529fa65...</value>
          <attributeID>POFLD_IDENTIFIER</attributeID>
        </attributes>
      </attributeSet>
    </adm:queryPendingOperation>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Query all pending operations that affect authenticator ranges (specified by a serial number range):

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <adm:queryPendingOperation xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <sessionID>wo]to7L]ChB^?iH1Bmi3jXUu#-ORG^Mh</sessionID>
      <attributeSet>
        <attributes>
          <value xsi:type="xsd:string">*To Serial Number*</value>
          <attributeID>POFLD_CONTEXT</attributeID>
        </attributes>
      </attributeSet>
    </adm:queryPendingOperation>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Requirements

Required administrative privileges:

Administrative logon

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

What's Next

viewPendingOperation (Command)

Table des matières

Parameters
Examples
Requirements