ListSystemUsers

July 21, 2025

This API lists the information of all system users.

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

  • System Settings > Basic > Administrative Access

URL

https://CBS.EXAMPLE.COM/obs/api/json/ListSystemUsers.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.
RoleOnly Boolean List the role of system users only (SystemUserRole).
Host String AhsayCBS’s URL. It is required for calling API from Redirector only.
Return Values
Key Type Description
Status String "OK" or "Error"
Data Array of SystemUserRole or Array of SystemUser If RoleOnly is true, an array of SystemUserRole is returned. Otherwise, an array of SystemUser is returned.
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".
JSON Objects

SystemUserRole

Key Type Description
Name String Name of user role.
Role String The value can be any one of the following: ADMIN, READ_ONLY_ADMIN, RESELLER and API_ONLY.

SystemUser

Key Type Description
Name String Name of user.
Role String The value can be any one of the following: ADMIN, READ_ONLY_ADMIN, RESELLER and API_ONLY.
Status String Can either be "SUSPENDED" or "ENABLED".
HashedPwd String Encrypted (Hashed) password of the user.
IsShowRebrandingPages Boolean True=Show Branding UI.
IsSendConsolidatedReport Boolean True=Send Consolidated Reports.
IsFreeTrialOfferAllowed Boolean True=Free Trial option is allowed. False=Free Trial option hidden, users cannot be set to Trial user type.
Example

INPUT 

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%"
}

OUTPUT 

{
	"Status":"OK",
	"Data":[
		{
		"Role":"ADMIN",
		"Status":"ENABLED",
		"HashedPwd":"ggeRi1mrAu37jPPCb6q6sRyBRlz/VxUgHbso6jqZu0I=",
		"IsShowRebrandingPages":false,
		"Name":"system",
		"IsFreeTrialOfferAllowed":true
		}
	]
}
Documentation