logon/logoff SOAP Request Structure

logon and logoff SOAP requests have the same format. A logon SOAP request typically use 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:logon>
      <attributeSet>
        <!--Zero or more repetitions:-->
        <attributes>
          <valuexsi:type="xsd:!!!!!!">?????</value>
          <attributeID>?????</attributeID>
        </attributes>
      </attributeSet>
    </adm:logon>
  </soapenv:Body>
</soapenv:Envelope>

The SOAP body element should only contain a logon or logoff element (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 logon or logoff request needs to follow these additional rules:

• The logon or logoff element should contain only one AttributeSet element.
• The AttributeSet element should contain zero or more provisioning attribute elements.

Each attribute element should contain the following sub-elements:

• attributeID (required). The attribute identifier. The supported credential attribute identifiers are listed in SOAP authentication (Overview).
• value (required). The attribute value. This element also requires the specification of the value type using the following attribute definition xsi=type=”xsd:type.

• attributeOptions (optional). This element provides directive information about how OneSpan Authentication Server should handle the attribute value during request processing. Following options are supported for this element:

  • NULL. Indicates that the specified attribute should be set to zero.
  • NEGATIVE. Used for search criteria to say NO when searching for a specific attribute.
  • MASKED. Used to indicate OneSpan Authentication Server to mask the attribute value (e.g. when auditing the SOAP request).

To set an attribute option, add the option element in the attributeOptions element and give the option element the value true.

To set the MASKED option, add the following:

<attributeOptions><masked>true</masked></attributeOptions>