Query Operations (SOAP API)

A query is a SOAP operation to perform searches on specified objects that exist within the OneSpan Authentication Server data model. Each administrative SOAP operation requires service user credentials or a successful administrative logon.

OneSpan Authentication Server provides an administrative session identifier (sessionID) as a response to a successful administrative logon request. Alternatively, when working with service users, the sessionID value is constructed using the service user’s credentials. Each administrative operation on the OneSpan Authentication Server requires the sessionID.

To perform a query operation via SOAP

1. Prepare a query SOAP request for the object upon which you want to perform a search:

   1. Specify sessionID in the SOAP request.

   2. Specify one or more search attributes as parameters for the SOAP operation.

      Attributes are key/value pairs. These search attributes define the search criteria for the SOAP query.

   3. Specify one or more object attributes that should be returned by the query.

      Optionally, you can specify various query options, e.g.:

      • distinctive
      • rowoffset
      • rowcount
      • count

2. Import the OneSpan Authentication Server SSL server certificate as trusted root certificate on the machine where your client application is running.

   This will allow your SOAP client application to connect to OneSpan Authentication Server securely via SSL.

3. Send the SOAP request to OneSpan Authentication Server. By default, the SOAP request should be transmitted over HTTPS with the OneSpan Authentication Server.

   By default, OneSpan Authentication Server is configured to accept SOAP requests on port 8888.

4. Receive the SOAP response.
5. Process the SOAP response.

For more information about the structure of SOAP messages, see SOAP message structure (SDK SOAP API).

After upgrading OneSpan Authentication Server, server data is continuously migrated while the already upgraded OneSpan Authentication Server service/daemon 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, for instance, values for new data fields or policy default settings may be missing or not set correctly in the query result.