userResponse Type

userResponse is returned for all user operations except getList and getListRemote.

userResponse always contains the following common elements:

  • authToken
  • resultCount
  • statusCode
  • statusMessage
  • summaryOnly

If resultCount is 1 and statusCode is 2000 (successful), the resultSet element is included after resultCount listing the following User details:

  • loginName
  • firstName
  • lastName
  • loginPassword
  • phone
  • email
  • enabled
  • privileges
  • devices
  • appliances (createUser, createUserRemote, updateUser, and updateUserRemote only)
  • changeLoginName (updateUser and updateUserRemote only)

If resultCount is 0 and statusCode is not 2000 (successful), an error is returned in statusMessage.

Example

SOAP response for userResponseType: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:createUserResponse xmlns:ns="UserService">
         <ns:return xsi:type="ax233:UserResponse" xmlns:ax233="http://user.services.logapp.loglogic.com/xsd" xmlns:ax234="http://services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax234:authToken xsi:nil="true"/>
            <ax234:resultCount>1</ax234:resultCount>
            <ax234:statusCode>2000</ax234:statusCode>
            <ax234:statusMessage>Successful</ax234:statusMessage>
            <ax234:summaryOnly>false</ax234:summaryOnly>
            <ax233:resultSet xsi:type="ax233:UserDetail">
               <ax233:alerts xsi:nil="true"/>
               <ax233:authenticationType>Local</ax233:authenticationType>
               <ax233:devices>All General Syslog</ax233:devices>
               <ax233:email>hello1@test.com</ax233:email>
               <ax233:enabled>Yes</ax233:enabled>
               <ax233:firstName>f1</ax233:firstName>
               <ax233:groups xsi:nil="true"/>
               <ax233:lastName>l1</ax233:lastName>
               <ax233:password/>
               <ax233:phone>123-456-7890</ax233:phone>
               <ax233:userId>1711576871403523</ax233:userId>
               <ax233:username>hello1</ax233:username>
            </ax233:resultSet>
         </ns:return>
      </ns:createUserResponse>
   </soapenv:Body>
</soapenv:Envelope>