Embedded Business Intelligence > WebFOCUS Security Administration RESTful Web Service Requests > Listing Groups

Listing Groups

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

HTTP Method: GET

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/SSYS/GROUPS?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 groups is retrieved.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/SSYS/GROUPS?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="GROUPS" dummy="false" fullPath="IBFS:/SSYS/GROUPS" name="GROUPS"
             policy="///+f///////9/////////////+AAAAA" type="WebFOCUSComponent">
    <children _jt="ArrayList" size="6">
       <item _jt="IBFSGroupObject" container="true" description="All defined users" dummy="false"
             fullPath="IBFS:/SSYS/GROUPS/EVERYONE" handle="10100" index="0" name="EVERYONE" parent="GROUPS"
             policy="///+f/////9/9////4f+//P///+AAAAA" type="Group">
          <users _jt="ArrayList" size="0"/>
       </item>
       <item _jt="IBFSGroupObject" container="true" description="Administrators" dummy="false"
             fullPath="IBFS:/SSYS/GROUPS/Administrators" handle="10101" index="1" name="Administrators" parent="GROUPS"
             policy="///+f///////9/////////////+AAAAA" type="Group">
          <users _jt="ArrayList" size="0"/>
       </item>
       <item _jt="IBFSGroupObject" container="true" description="Anonymous Users" dummy="false"
             fullPath="IBFS:/SSYS/GROUPS/Anonymous" handle="10104" index="2" name="Anonymous" parent="GROUPS"
             policy="///+f///////9/////////////+AAAAA" type="Group">
          <users _jt="ArrayList" size="0"/>
       </item>
       <item _jt="IBFSGroupObject" container="true" 
description="Userid/Group Administrators" dummy="false"
             fullPath="IBFS:/SSYS/GROUPS/UserAdmins" handle="10106" index="3" name="UserAdmins" parent="GROUPS"
             policy="///+f///////9/////////////+AAAAA" type="Group">
          <users _jt="ArrayList" size="0"/>
       </item>
       <item _jt="IBFSGroupObject" container="true" description="WebFOCUS Global Roles" dummy="false"
             fullPath="IBFS:/SSYS/GROUPS/WF_Global_Roles" handle="10111" index="4" name="WF_Global_Roles" parent="GROUPS"
             policy="///+f///////9/////////////+AAAAA" type="Group">
         <users _jt="ArrayList" size="0"/>
       </item>
       <item _jt="IBFSGroupObject" container="true" description="WebFOCUS Global Permissions" dummy="false"
             fullPath="IBFS:/SSYS/GROUPS/WF_Global_Permissions" handle="10116" index="5" name="WF_Global_Permissions"             parent="GROUPS" policy="///+f///////9/////////////+AAAAA" type="Group">
         <users _jt="ArrayList" size="0"/>
      </item>
    </children>
 </rootObject>
</ibfsrpc>

Each group definition is defined within the opening and closing item tag. The name attribute defines the name of the group. The description attribute defines the title for the group.

WebFOCUS

Feedback