This RESTful web service request can be used to retrieve a list of existing WebFOCUS users within a particular group.
HTTP Method: GET
REST URL Format:
http://host:port/ibi_apps/rs/ibfs/SSYS/GROUPS/Group?IBIRS_action=get&IBIRS_args=
<object _jt="HashMap">
<entry>
<key _jt="string" value="TYPE"/>
<value _jt="string" value="USERS"/>
</entry>
</object>
where:
Is the name of the system where WebFOCUS is installed.
Is the port number used by WebFOCUS.
Is the name of the group.
Example:
In the following example, a list of WebFOCUS users within the Administrators group is retrieved.
Request:
http://localhost:8080/ibi_apps/rs/ibfs/SSYS/GROUPS/Administrators?IBIRS_action=get&IBIRS_args= <object _jt="HashMap"> <entry> <key _jt="string" value="TYPE"/> <value _jt="string" value="USERS"/> </entry> </object>
Response:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <ibfsrpc _jt="IBFSResponseObject" language="EN" name="get" returncode="10000" returndesc="SUCCESS" subreturncode="0" subsystem="SSYS" type="simple"> <ibfsparams size="2"> <entry key="IBIRS_args" value="<object _jt="HashMap"><entry><key _jt="string" value="TYPE"/><value _jt="string" value="USERS"/></entry></object>"/> <entry key="IBIRS_" value="/SSYS/GROUPS/Administrators"/> </ibfsparams> <rootObject _jt="IBFSGroupObject" container="true" description="Administrators" dummy="false" fullPath="IBFS:/SSYS/GROUPS/Administrators" name="Administrators" policy="////D///9+P/////v/////////+AAAA=" rsPath="/ibi_apps/rs/ibfs/SSYS/GROUPS/Administrators" type="Group"> <children _jt="ArrayList" size="4"> <item _jt="IBFSUserObject" description="Administrator" dummy="false" email="restadmin@informationbuilders.com" fullPath="IBFS:/SSYS/USERS/admin" handle="10001" index="0" name="admin" parent="Administrators" policy="////D///9+P/////v/////////+AAAA=" rsPath="/ibi_apps/rs/ibfs/SSYS/USERS/admin" 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="1" name="mradmin1" parent="Administrators" policy="////D///9+P/////v/////////+AAAA=" rsPath="/ibi_apps/rs/ibfs/SSYS/USERS/mradmin1" type="User"> <status _jt="IBSSUserStatus" name="ACTIVE"/> <groups _jt="ArrayList" size="0"/> <pSetList _jt="ArrayList" size="0"/> </item> <item _jt="IBFSUserObject" description="Rest Userid" dummy="false" email="restid@informationbuilders.com" fullPath="IBFS:/SSYS/USERS/restid77" handle="222102528" index="2" name="restid" nameSpace="DB" parent="Administrators" policy="////D///9+P/////v/////////+AAAA="
rsPath="/ibi_apps/rs/ibfs/SSYS/USERS/restid77" type="User"> <status _jt="IBSSUserStatus" name="ACTIVE"/> <groups _jt="ArrayList" size="0"/> <pSetList _jt="ArrayList" size="0"/> </item> </children> <users _jt="ArrayList" size="0"/> </rootObject> </ibfsrpc>
Each user is defined within the opening and closing item tag. The name attribute defines the name of the user. The description attribute defines the title for the user.
WebFOCUS |