SendForgotPwdEmail

July 21, 2025

This API will send a forgot password email to a backup user who forgot their login password, to allow them to reset their login password.

URL

https://CBS.EXAMPLE.COM/obs/api/json/SendForgotPwdEmail.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).
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":"system",
	"SysPwd":"system1",
	"LoginName":"obm"
}

OUTPUT 

{
	"Status":"OK"
}

Example 2: Login name is incorrect / does not exist

INPUT 

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2"
}

OUTPUT 

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