<object>query SOAP Request Structure

An objectquery SOAP request typically uses the following format:

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
  <soapenv:Header/>
  <soapenv:Body>
    <adm:????Query>
      <sessionID>?</sessionID>
      <attributeSet>
        <!--Zero or more repetitions:-->
        <attributes>
          <!--Optional:-->
          <attributeOptions>
            <!--Optional:-->
            <negative>?</negative>
            <!--Optional:-->
            <masked>?</masked>
            <!--Optional:-->
            <null>?</null>
          </attributeOptions>
          <value>?</value>
          <attributeID>?</attributeID>
        </attributes>
      </attributeSet>
      <!--Optional:-->
      <fieldSet>
        <!--Zero or more repetitions:-->
        <attributeID>?</attributeID>
      </fieldSet>
      <!--Optional:-->
      <queryOptions>
        <!--Optional:-->
        <distinct>?</distinct>
        <!--Optional:-->
        <rowoffset>?</rowoffset>
        <!--Optional:-->
        <rowcount>?</rowcount>
        <!--Optional:-->
        <count>?</count>
      </queryOptions>
    </adm:??????Query>
  </soapenv:Body>
</soapenv:Envelope>

The SOAP body element should only contain an objectquery element, where object specifies the requested object (line 8). This element is defined in the namespace adm. Therefore, adm needs to be declared in the Envelope element as an attribute.

A valid objectquery request needs to follow these additional rules:

• The objectquery element should contain only one AttributeSet element.
• The AttributeSet element should contain zero or more attribute elements. These attribute elements define the query search criteria.
• The objectquery element should contain one sessionID element. To get an administrative session identifier (sessionID), an administrative logon has to be executed. Alternatively, when working with service users, sessionID is constructed using the service user's credentials (see Administrative logon/logoff (SOAP API)).
• The objectquery element should contain one cmd element.

Search fields specified using the AttributeSet elements are interpreted as follows:

• Wildcards are always accepted when indicated, except for user and authenticator searches. For these requests, they are accepted only if the toUserID or toSerial parameters are not set.
• 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.

Optionally, a valid objectquery request can contain one of each of the following elements:

• fieldSet. If specified, the fieldSet element should contain zero or more object attribute elements. These elements specify the object fields that OneSpan Authentication Server should return for the each of the objects matching the search criteria.

• queryOptions. This element determines which results should be returned. The following optionas are supported:

  • distinct. A flag to request query results with no duplicate entries. This option is of type boolean.
  • rowoffset. Option to request results starting from the specified offset. This option is of type unsignedInt.
  • rowcount. Option to request to return the specified number of records in the results. This option is of type unsignedInt.
  • count. A flag to request the count of the results only, not the results themselves. This option is of type boolean.