ModifyUserGroup

July 21, 2025

This API lets you modify the name of the User Group, add users or delete user to / from a User Group.

The settings can be found on the AhsayCBS web console at:

  • Backup / Restore > Users, Groups & Policies > User Group

URL

https://CBS.EXAMPLE.COM/obs/api/json/ModifyUserGroup.do

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
ID String User Group ID obtainable from ListUserGroups API.
UserGroupName String Name of the user group.
UserIdList String User names to be added to or removed from the user group. Multiple login names, separated by commas, are accepted. For example: user1, user2, user3.
Mode String The value can be one of the following: A (default value) or D. IF the value is "A", users in UserIdList will be added to the user group. If the value is "D", users in the UserIdList will be removed from the user group.
Return Values
Key Type Description
Status String "OK" or "Error"
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, will only be displayed if the status is "Error".
Examples

Example 1

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"ID":"1447039919940",
	"UserIdList":"user",
	"Mode":"D"
}

OUTPUT

{
	"Status":"OK"
}

OUTPUT - User does not exist

{
	"Status":"Error",
	"Message":"[UserCacheManager.NoSuchUserExpt] User ‘user’ not found.",
	"ExptType":"com.ahsay.obs.core.dbs.Y"
}

Example 2: Incorrect parameter mode

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"ID":"1447039919940",
	"UserIdList":"user",
	"Mode":"S"
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter Mode must either be A or D!",
	"ExptType":"com.ahsay.obs.core.dbs.c"
}
Documentation