getUserById

The following example is a SOAP request to get a user by the specified ID.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>BAB25F1A2A1ADCC0BB0D455D41354509</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:getUserById>
   <sec:id>9707B975E42F2B6135D6FB0FA36C4E53</sec:id>
  </sec:getUserById>
 </soapenv:Body>
</soapenv:Envelope>

The following example is the SOAP reply to the request.

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getUserByIdResponse xmlns:ns2="http://www.approuter.com/
  schemas/2008/1/security" xmlns:ns3="http://www.approuter.com/schema/
  router/1000/security/03">
   <ns2:user>
    <ns3:id>9707B975E42F2B6135D6FB0FA36C4E53</ns3:id>
    <ns3:name>webman</ns3:name>
    <ns3:encPasswd>{SHA}gf/yUAZHWaZFHdCMaxDHVmmd4FE=</ns3:encPasswd>
    <ns3:displayName>Webuser</ns3:displayName>
    <ns3:isActive>true</ns3:isActive>
    <ns3:isMutable>true</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:email>webman@castiron.com</ns3:email>
    <ns3:createdTime>2010-03-11T19:03:46.737Z</ns3:createdTime>
    <ns3:failedLoginCount>0</ns3:failedLoginCount>
    <ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
    <ns3:scopeType>Tenant</ns3:scopeType>
   </ns2:user>
  </ns2:getUserByIdResponse>
 </S:Body>
</S:Envelope>

For each user the following information is returned:

id

The ID for the user.

name

The name for the user.

encPasswd

The SHA encoded password for the user.

displayName

The name displayed in the WMC for the user.

isActive

True or false depending on whether the user is logged in.

isMutable

True or false. True means that the object can be updated. False means that the object cannot be updated.

isVisible

True or false. True means that the object is visible in the WMC.

email

tThe email address for the user.

createdTime

The date and time the user was created.

failedLoginCount

The number of failed attempts to log in by using this name. After five failures, the username is blocked for 15 seconds. For each successive failure, the blocked time is doubled (15 - 30 - 60 - 120).

scopeId

The scope ID for the scope where the user is located. Applies to Cloud only.

scopeType

The type of scope, either tenant or environment. Applies to Cloud only.