getUser
Gets the user for specified username.
Applies to Clouds and Integration Appliances.
Parameter:
- username
- The specified username.
- Returns:
- The user corresponding to the specified username.
Examples:
The following example is a SOAP
request to get a user by using the specified username.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
<soapenv:Header>
<sec:sessionId>BF1E7729085BB066446DF913FAE34596</sec:sessionId>
</soapenv:Header>
<soapenv:Body>
<sec:getUser>
<sec:username>webman</sec:username>
</sec:getUser>
</soapenv:Body>
</soapenv:Envelope>
The following example is
the SOAP response to the request.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getUserResponse 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>965AAB3FED8D3CCBBE4DC8EE0E2944EA</ns3:id>
<ns3:name>webman</ns3:name>
<ns3:encPasswd>{SHA}clO20r2ZJMJcDrNwXQzhWB8YcdI=</ns3:encPasswd>
<ns3:displayName>WebServiceUser</ns3:displayName>
<ns3:isActive>true</ns3:isActive>
<ns3:isMutable>true</ns3:isMutable>
<ns3:isVisible>true</ns3:isVisible>
<ns3:email>webman@mycompany.com</ns3:email>
<ns3:createdTime>2010-03-02T22:11:32.935Z</ns3:createdTime>
<ns3:failedLoginCount>0</ns3:failedLoginCount>
<ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
<ns3:scopeType>Tenant</ns3:scopeType>
</ns2:user>
</ns2:getUserResponse>
</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 role.
- isActive
- True if the user is logged in, false if not.
- isMutable
- True or false. True means that the object can be updated, false if not.
- isVisible
- True or false. True means that the object is visible in the WMC, false if not.
- The 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. Does not apply for Integration Appliances.
- scopeType
- The type of scope, either tenant or environment. Does not apply for Integration Appliances.