User Administration Operations (SOAP API)

Prev Next

The administration interface supports the following SOAP operations to perform user administration commands:

  • userExecute
  • userQuery

For more information about these commands, see SOAP administration (Overview).

A client administration application will typically send the following SOAP request to view the user attributes of user test1 created in domain master:

<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:userExecute>
      <sessionID>ZWo~ORIG-SqrgLN[Y-he~jpbZjegoNxr</sessionID>
      <cmd>USERCMD_VIEW</cmd>
      <attributeSet>
        <attributes>
          <value xsi:type="xsd:string">test1</value>
          <attributeID>USERFLD_USERID</attributeID>
        </attributes>
        <attributes>
          <value xsi:type="xsd:string">master</value>
          <attributeID>USERFLD_DOMAIN</attributeID>
        </attributes>
      </attributeSet>
    </adm:userExecute>
  </soapenv:Body>
</soapenv:Envelope>

A client administration application will typically send the following SOAP request to query users whose user IDs start with f, only returning the user ID in the search results:

<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:userQuery>
      <sessionID>wiy6ywXaFwR8wdzXsq7b4Jo5BPSfq4J6</sessionID>
      <attributeSet>
        <attributes>
          <value xsi:type="xsd:string">f*</value>
          <attributeID>USERFLD_USERID</attributeID>
        </attributes>
      </attributeSet>
      <fieldSet>
        <attributeID>USERFLD_USERID</attributeID>
      </fieldSet>
    </adm:userQuery>
  </soapenv:Body>
</soapenv:Envelope>