DeleteUserGroup

July 21, 2025

This API allows you to delete a user group and all its information.

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

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

URL

https://CBS.EXAMPLE.COM/obs/api/json/DeleteUserGroup.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 ID of 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".
Example

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456",
	"ID":"1497232492006"
}

OUTPUT 1 

{
	"Status":"OK"
}

OUTPUT 2 - User group does not exist 

{
	"Status":"Error",
	"Message":"[Error] Parameter UserGroupID, 1497232492006 does not exist.",
	"ExptType":"com.ahsay.obs.core.dbs.Y"
}
Documentation