ModifyUserStatus

July 21, 2025

This API can be used to modify a user account status to either enable or suspended. It cannot be used for trial user accounts which are suspended after they have exceeded the trial period.

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

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

 

URL

https://CBS.EXAMPLE.COM/obs/api/json/ModifyUserStatus.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.
LoginName String Backup user name.
Owner String Owner of the backup user (if applicable).
Status String Status of the backup user, either ENABLE or SUSPENDED.
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":"system",
	"SysPwd":"system1",
	"LoginName":"obm2",
	"Status":"SUSPENDED"
}

OUTPUT 

{
	"Status":"OK"
}

OUTPUT 2: User does not exist 

{
	"Status":"Error",
	"Message":"[UserCacheManager.NoSuchUserExpt] User ‘obm2’ not found.",
	"ExptType":"com.ahsay.obm.core.dbs.ai"
}
Documentation