Adding a User to a Group

This RESTful web service request can be used to add a user to a group.

HTTP Method: POST

REST URL Format:

http://host:port/ibi_apps/rs/ibfs/SSYS/USERS/Userid

where:

host

Is the name of the system where WebFOCUS is installed.

port

Is the port number used by WebFOCUS.

Userid

Is the name of the user ID to be added to a group.

Body Format:

IBIRS_action=addUserToGroup&IBIRS_groupPath=GroupPaths

where:

GroupPaths

Are the paths to groups that the user ID is to be added. For example:

/SSYS/GROUPS/group1;/SSYS/GROUPS/group2

Example:

In the following example, the user ID restid is added to the RestUsers group.

Request:

http://localhost:8080/ibi_apps/rs/ibfs/SSYS/USERS/restid

Body:

IBIRS_action=addUserToGroup&IBIRS_groupPath=/SSYS/GROUPS/RestUsers

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="IBFSUserObject" description="Rest Userid" dummy="false" email="restid@informationbuilders.com"
               fullPath="IBFS:/SSYS/USERS/restid" handle="739804165" name="restid" nameSpace="DB"
password="$c35587264cbbbe38$ce25f3b448103e2031ee0b943bf8fd031b7b
ac26e1e0591da4bb7105d2672f206de9eb7b39d4
                 fb83eb6a01a0faea2ff1ec2ccaa70103f7723c89d0d426098c32"
policy="///+f///////9/////////////+AAAAA" type="User">
      <status _jt="IBSSUserStatus" name="ACTIVE"/>
      <groups _jt="ArrayList" size="2">
         <item _jt="IBFSGroupObject" container="true" description="RESTful Web Services Users" dummy="false"
               fullPath="IBFS:/SSYS/GROUPS/RestUsers" handle="1113254912" index="0" name="RestUsers" type="Group">
            <users _jt="ArrayList" size="0"/>
         </item>
         <item _jt="IBFSGroupObject" container="true" description="All defined users" dummy="false"
               fullPath="IBFS:/SSYS/GROUPS/EVERYONE" handle="10100" index="1" name="EVERYONE" type="Group">
             <users _jt="ArrayList" size="0"/>
         </item>
      </groups>
      <pSetList _jt="ArrayList" size="0"/>
   </rootObject>
</ibfsrpc>

If the value for the returncode attribute in the XML response is 10000, then the user ID was added successfully to the group.


Information Builders