AuthUser

July 21, 2025

This API checks whether a user exists or not.

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

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

 

URL

https://CBS.EXAMPLE.COM/obs/api/json/AuthUser.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 Name of the backup user.
Owner String The owner of backup user (if applicable).
Password String Password used to login.
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, it appears only if status is "Error".
Example

INPUT 

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"SampleUser",
	"Password":"SamplePassword"
}

OUTPUT 1 

{
	"Status":"OK"
}

OUTPUT 2: User does not exist 

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