getUsers

Gets a list of all the users based on the session ID.

Applies to Clouds and Integration Appliances.

Returns:
The users

Examples:

The following example is a SOAP request to get users. The input for the request is the session 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>8EB8F17160F7D1E561EC45EFEBF344CF</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:getUsers/>
 </soapenv:Body>
</soapenv:Envelope>
The following example is the SOAP reply to the request to get users:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getUsersResponse xmlns:ns2="http://www.approuter.com/
  schemas/2008/1/security" xmlns:ns3="http://www.approuter.com/schema/
  router/1000/security/03">
   <ns2:users>
    <ns3:id>860DDF6E8DE511EF0EA8E249A1514EA1</ns3:id>
    <ns3:name>foo@mycompany.com</ns3:name>
    <ns3:encPasswd>{SHA}L84w50sj87W4IQUhr2NqKsuO8kI=</ns3:encPasswd>
    <ns3:displayName>Foo</ns3:displayName>
    <ns3:isActive>true</ns3:isActive>
    <ns3:isMutable>true</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:email>foo@mycompany.com</ns3:email>
    <ns3:createdTime>2010-02-24T23:12:10.252Z</ns3:createdTime>
    <ns3:failedLoginCount>0</ns3:failedLoginCount>
    <ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
    <ns3:scopeType>Tenant</ns3:scopeType>
   </ns2:users>
   <ns2:users>
    <ns3:id>90D63CC6F3A5F90C587B2B478858432D</ns3:id>
    <ns3:name>admin@mycompany.com</ns3:name>
    <ns3:encPasswd>{SHA}8eQYsQgWL3V0sLf7akuJO5wM11c=</ns3:encPasswd>
    <ns3:displayName>admin@mycompany.com</ns3:displayName>
    <ns3:isActive>true</ns3:isActive>
    <ns3:isMutable>false</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:email>admin@mycompany.com</ns3:email>
    <ns3:createdTime>2010-02-12T21:50:35Z</ns3:createdTime>
    <ns3:lastLoginTime>2010-03-10T17:20:39.774Z</ns3:lastLoginTime>
    <ns3:lastFailedLoginTime>2010-03-03T18:25:24.936Z</
    ns3:lastFailedLoginTime>
    <ns3:failedLoginCount>0</ns3:failedLoginCount>
    <ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
    <ns3:scopeType>Tenant</ns3:scopeType>
   </ns2:users>
   <ns2:users>
    <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:users>
   <ns2:users>
    <ns3:id>B77F69E6D9488E2607B02076B4F848DC</ns3:id>
    <ns3:name>support@mycompany.com</ns3:name>
    <ns3:encPasswd>{SHA}Ek2MpQlE1+fGMEYo1kSF6lpbNIk=</ns3:encPasswd>
    <ns3:displayName>support@mycompany.com</ns3:displayName>
    <ns3:isActive>false</ns3:isActive>
    <ns3:isMutable>false</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:email>support@mycompany.com</ns3:email>
    <ns3:createdTime>2010-02-12T21:50:35Z</ns3:createdTime>
    <ns3:failedLoginCount>0</ns3:failedLoginCount>
    <ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
    <ns3:scopeType>Tenant</ns3:scopeType>
   </ns2:users>
  </ns2:getUsersResponse>
 </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 if not.
isVisible
True or false. True means that the object is visible in the WMC, false if not.
email
The email address for the user.
createdTime
The date and time the user was created.
failedLoginCount
The number of failed attempts to log in to the tenant by using this name. After five failures, the username is blocked for 15 seconds. For each successive failure, the blocked time is doubled.
scopeId
The scope ID for the scope where the user is located. Applies to Clouds only.
scopeType
The type of scope, either tenant or environment. Applies to Clouds only.



Feedback | Notices


Timestamp icon Last updated: Wednesday, December 16, 2015


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.api.doc/ci00034.html