RemoveSysUser

July 21, 2025

This API can be used to remove a system user.

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

  • System Settings > Basic > Administrative Access

URL

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

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin, API or Read-Only API role.
SysPwd String Password matching SysUser.
RemoveLoginName String Login name of the system user to be removed.
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":"sample",
	"SysPwd":"sample",
	"RemoveLoginName":"dummyAdmin"
}

OUTPUT 

{
	"Status":"OK"
}

Example 2: If the system user does not exist

INPUT 

{
	"SysUser":"sample",
	"SysPwd":"sample",
	"RemoveLoginName":"nosuchuser"
}

OUTPUT 

{
	"Status":"Error",
	"Message":"System user ‘nosuchuser’ does not exist",
	"ExptType":"org.json.JSONException"
}
Documentation