Listing Users

This RESTful web service request can be used to retrieve a list of existing WebFOCUS users.

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/SSYS/USERS?IBIRS_action=get

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

Example:

In the following example, a list of WebFOCUS users is retrieved.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/SSYS/USERS?IBIRS_action=get

Response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ibfsrpc _jt="IBFSResponseObject" language="EN" name="IBIRS_action" returncode="10000"
   returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple">
 <ibfsparams size="0"/>
 <rootObject _jt="IBFSObject" container="true" description="USERS" dummy="false"
   fullPath="IBFS:/SSYS/USERS" name="USERS" policy="///+f///////9/////////////+AAAAA"
   type="WebFOCUSComponent">
  <children _jt="ArrayList" size="7">
   <item _jt="IBFSUserObject" description="Administrator" dummy="false" email="efrem.litwin@gmail.com"
      fullPath="IBFS:/SSYS/USERS/admin" handle="10001" index="0" name="admin" parent="USERS"
password="$faa2f1da92f72a7d$0901495f1d42962aa242af8aad5c7958a9f86013a1904
password="$94b192f81526ff9d$e71362964a5c2ef8e7814824dc247c8ee012ea118c1f6
0402e2467f8ba0e5bcc508c3a8d973ecce0a8738d7445e25dcfb9a96411f6c7af6e6a5fe1
      051ccb669a" policy="///+f///////9/////////////+AAAAA" type="User">
    <status _jt="IBSSUserStatus" name="ACTIVE"/>
    <groups _jt="ArrayList" size="0"/>
    <pSetList _jt="ArrayList" size="0"/>
   </item>
   <item _jt="IBFSUserObject" description="MR admin 1" dummy="false" email=""
      fullPath="IBFS:/SSYS/USERS/mradmin1" handle="10004" index="2" name="mradmin1" parent="USERS"
password="$ed23192360fccc75$6a8e50345185367b57f98b863e55b7e44fc94d10d3a1b
0b6796774b694321bb57d6af841a30a4bd7f698c1e353db3cefe332e504bc854fe7878d12
      f664cc6cde" policy="///+f///////9/////////////+AAAAA" type="User">
    <status _jt="IBSSUserStatus" name="ACTIVE"/>
    <groups _jt="ArrayList" size="0"/>
    <pSetList _jt="ArrayList" size="0"/>
   </item>
   <item _jt="IBFSUserObject" description="MR developer 1" dummy="false" email=""
82974970e81ee0259ba82cbd3856f01c6f29a14abaf602143b5e79b3f18a4244b9018d911
      5892d363f4" policy="///+f///////9//////+//////+AAAAA" type="User">
    <status _jt="IBSSUserStatus" name="ACTIVE"/>
    <groups _jt="ArrayList" size="0"/>
    <pSetList _jt="ArrayList" size="0"/>
   </item>
   <item _jt="IBFSUserObject" description="Basic user" dummy="false" email=""
      fullPath="IBFS:/SSYS/USERS/auser" handle="10002" index="1" name="auser" parent="USERS"
      fullPath="IBFS:/SSYS/USERS/mrdev1" handle="10005" index="3" name="mrdev1" parent="USERS"
password="$01265dd1edf5431e$229e70a1c6068b977b241a63d0357818ac790448cb466
d9c38e113380c29849f5a803025da486b9d7708025a4dd239d9ca123f458bfc7ff18ea5ae
      732c30a67e" policy="///+f///////9/////////////+AAAAA" type="User">
    <status _jt="IBSSUserStatus" name="ACTIVE"/>
    <groups _jt="ArrayList" size="0"/>
    <pSetList _jt="ArrayList" size="0"/>
   </item>
   <item _jt="IBFSUserObject" description="WebFOCUS Public User" dummy="false" email=""
      fullPath="IBFS:/SSYS/USERS/public" handle="10007" index="4" name="public" parent="USERS"
password="$4a4d50e70fc99c07$2306ff856f98e3a01bf3742f29e77a48078fb7447e1e9
812a940e8f5b1cccb0132beb752de8d2af70ee45531934da6b0f2d1c81bd108af56d12a10
      6cdff8492f" policy="///+f///////9/////////////+AAAAA" type="User">
    <status _jt="IBSSUserStatus" name="ACTIVE"/>
    <groups _jt="ArrayList" size="0"/>
    <pSetList _jt="ArrayList" size="1">
     <item _jt="string" index="0" value="WF_Role_Public"/>
    </pSetList>
   </item>
   <item _jt="IBFSUserObject" description="User and Group administrator" dummy="false" email=""
      fullPath="IBFS:/SSYS/USERS/useradmin" handle="10006" index="5" name="useradmin" parent="USERS"
password="$e7ac6cd796e2c928$569217829f425b3be8686288a648e1102bf5323140f79
b2051c920d59fc3f4cce410da7e49448a7f0efc849af04dfe92cd4ec2b78cdd59551981d9
      a1799cd0a3" policy="///+f///////9/////////////+AAAAA" type="User">
    <status _jt="IBSSUserStatus" name="ACTIVE"/>
    <groups _jt="ArrayList" size="0"/>
    <pSetList _jt="ArrayList" size="0"/>
   </item>
   <item _jt="IBFSUserObject" description="Desktop guest account" dummy="false" email=""
      fullPath="IBFS:/SSYS/USERS/wfdesktop" handle="10008" index="6" name="wfdesktop" parent="USERS"
password="$2d38eaabdf1c9719$d0b1b037587903b60623a1983a8064b626688b0182388
6215b445950752ab90de846c0caa4d0787f66835fbf642c190d040c518e816d99ce06ba50
      e5f2485b8a" policy="///+f///////9/////////////+AAAAA" type="User">
    <status _jt="IBSSUserStatus" name="ACTIVE"/>
    <groups _jt="ArrayList" size="0"/>
    <pSetList _jt="ArrayList" size="0"/>
   </item>
  </children>
 </rootObject>
</ibfsrpc>

Each user definition is defined within the opening and closing item tag. The name attribute defines the name of the user ID. The description attribute defines the title for the user. The email attribute defines the email address for the user. The name attribute within the status element defines whether the user ID is active. For example:

<status name="ACTIVE" _jt="IBSSUserStatus"/>

Note: The password attribute is not a value.


WebFOCUS