[v10] ListUsers (v1,v2)

October 14, 2025

This API can be used to retrieve user’s information, with various filter options.

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

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

 

v1 ListUsers.do

URL

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

Deprecated Since Version: 7.15.6.38

 

v2 ListUsers.do

v2 ListUsers.do API was introduced for handling of features related to Quota Management.

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/ListUsers.do

Available Since Version: 9.7

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
Criteria String Different criteria for searching.
searchBy String Criteria to use for searching.
searchStr String Only users with login name that contains searchStr are listed.
reseller String Login name of a reseller. Only users under reseller are listed.
UserGroupID String ID of a user group. Only users under that user group are listed.
PolicyGroupID String ID of a policy group. Only users under that policy group are listed.
Date String Number of days. Only users registered within that number of days are listed.
ClientType String OBM / ACB. Only that type of users are listed.
LoginNameOnly Boolean If true, only login name of users are returned.
ClientTypeOnly Boolean If true, only login name and client type of users are returned.
Return Values
Key Type Description
Status String "OK" or "Error"
User Array If ClientTypeOnly is true, an array of UserClientType is returned. If LoginNameOnly is true, an array of UserLoginName is returned. Otherwise, an array of User 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

UserClientType

Key Type Description
ID String ID of the backup user.
LoginName String Client user name.
Owner String Owner of the user.
UserId String Unique ID for each user.
ClientType String ACB / OBM.
QuotaUsed Integer User quota used by the user.

UserLoginName

Key Type Description
ID String ID of the backup user.
LoginName String Client user name.
Owner String Owner of the user.
UserId String Unique ID for each user.
ClientType String ACB / OBM.
QuotaUsed Integer User quota used by the user.

User

Key Type Description
ID String ID of the backup user.
LoginName String Client user name.
Owner String Owner of the user.
UserId String Unique ID for each user.
Alias String Display name.
UserType String TRIAL / PAID. Default to TRIAL if not specified.
ClientType String ACB / OBM.
QuotaUsed Integer User quota used by the user.
DestinationQuotaList Array Array list of Destination Quota settings.
DestinationName String Name of target destination.
DestinationKey Long Encryption key for the destination.
Online Boolean True / False.
Timezone String Timezone of the user.
Language string Language used.
DataFile Long Number of files in data area (Exclude local destination).
DataSize Long Compressed size of data area (Exclude local destination).
RetainFile Long Number of files in retention area (Exclude local destination).
RetainSize Long Compressed size of retention area (Exclude local destination).
EnableMSSQL Boolean Add-on module of MS SQL backup.
EnableMSExchange Boolean Add-on module of MS Exchange backup.
MsExchangeQuota Long Quota of MS Exchange.
EnableMsWinSysState Boolean Add-on module of Windows System State backup.
EnableOracle Boolean Add-on module of Oracle backup.
EnableLotusNotes Boolean Add-on module of Lotus Notes backup.
EnableLotusDomino Boolean Add-on module of Lotus Domino backup.
EnableMySQL Boolean Add-on module of MySQL backup.
EnableInFileDelta Boolean Add-on module of In-File Delta feature.
EnableShadowCopy Boolean Add-on module of Volume Shadow Copy feature.
EnableExchangeMailbox Boolean Add-on module of Exchange Mailbox backup.
ExchangeMailboxQuota Long Quota of Exchange Mailbox.
EnableNASClient Boolean Add-on module of Synology NAS backup.
EnableMariaDB Boolean Add-on module of MariaDB backup.
EnableQNAP Boolean Add-on module of QNAP NAS backup.
EnableDeltaMerge Boolean Add-on module of Delta Merge.
EnableMsVm Boolean Add-on module of Hyper-V backup.
EnableOpenDirect Boolean Add-on module of OpenDirect feature.
OpenDirectQuota Long OpenDirect quota. Parameter only works on pre-v9.13 AhsayCBS.
MsVmQuota Long Quota of Hyper-V module.
EnableVMware Boolean Add-on module of VMware backup.
VMwareQuota Long Number of Guest VM allowed.
GoogleWorkspaceQuota Long Number of Google Workspace accounts allowed.
Bandwidth Long Bandwidth lmitation of user.
Notes String Backup user notes.
Status String Status of the user, either SUSPENDED or ENABLE.
RegistrationDate Long Date of backup user registration.
SuspendPaidUser Boolean True / False
SuspendPaidUserDate String Date when backup user will be suspended.
LastBackupDate Long Latest date when backup job was run.
EnableCDP Boolean Add-on module of Continuouos Data Protection.
EnableShadowProtectBareMetal Boolean Add-on module of ShadowProtect backup.
EnableWinServer2008BareMetal Boolean Add-on module of Windows system backup.
MsVmQuotaType String Quota type which can ba GUESTVM or SOCKET.
VMwareQuotaType String Quota type which can ba GUESTVM or SOCKET.
EnableMobile Boolean Add-on module of Mobile backup.
MobileQuota Long Quota for mobile.
EnableOffice365Mail Boolean Add-on module of Microsoft 365 backup.
Office365MailQuota Long Quota for Microsoft 365.
Hostname String URL or hostname used to access AhsayCBS.
LdapUser String LDAP user account.
LdapDeleteUser Long Date LDAP account was deleted.
LdapDisableUser Long Date LDAP account was disabled.
ExpiryDate Long Expiry date of backup user account.
LatestClientVersion String Latest version used by the client.
UserGroupIDList Array Array of user group ID.
UserHome String Path of the User Home directory.
Contact Array Array list of contacts.
QuotaList Array Array of backup quota for backup destination.
ModuleUsage Array Array of license used per module.
QuotaType String Type of quota, either TOTAL_QUOTA or PER_DESTINATION_QUOTA.
StorageQuota Long Total quota in GB. Value validity examined when used by TOTAL_QUOTA.
EnableDeduplication Boolean Add-on module of Deduplication.
EnableMobileV2 Boolean Add-on module of Ahsay Mobile.
EnableTibero Boolean Add-on module of Tibero backup.
EnableLinuxBareMetal Boolean Add-on module of Linux Bare Metal backup.
EnablePostgreSQL Boolean Add-on module of PostgreSQL backup.
EnableGws Boolean Add-on module of Google Workspace backup.
EnableProxmox Boolean Add-on module of Proxmox VE backup.

QuotaList

Key Type Description
Enabled Boolean True / False
DestinationName String Name of the backup destination.
DestinationKey String ID of the backup destination, or OBS for quota on AhsayCBS.
Quota Integer Unit in bytes. Value validity examined when used by PER_DESTINATION_QUOTA.

UserGroup

Key Type Description
UserGroupID String ID of the user group.
UserGroupName String Name of the user group.
ShowLink Boolean True / False

Contact

Key Type Description
Name String Name of the contact.
Email String Email address of the contact.

ModuleUsage

Key Type Description
MSExMailbox Long Usage of MSExMailbox module license.
MSHyperVVM Long Usage of MSHyper-V VM module license.
VMwareVM Long Usage of VMware VM module license.
Office365Mail Long Usage of Microsoft 365 module license.
HostCount Long Usage of OBM / ACB license.
Example

INPUT 

{
	"SysUser":"system",
	"SysPwd":system1",
	"searchStr":"obm"
}

OUTPUT 

{
	"Status":"OK",
	"User":[
		{
			"Timezone":"1098",
			"MobileQuota":0,
			"LoginName":"38367_new",
			"Owner":"",
			"ExpiryDate":25,
			"UserGroupIDList":[
				{
					"ShowLink":false,
					"UserGroupID":"1",
					"UserGroupName":"All Users"
				}
			],
			"EnableNASClient":false,
			"EnableMariaDB":false,
			"EnableOpenDirect":false,
			"DataFile":0,
			"MsVmQuotaType":"GUESTVM",
			"EnableShadowProtectBareMetal":false,
			"LdapUser":false,
			"EnableMobile":false,
			"DataSize":0,
			"EnableLotusDomino":false,
			"UserHome":"C:\\Users\username\Documents\cbase\user\38367_new",
			"ID":"1703141283712",
			"MsVmQuota":0,
			"Status":"ENABLE",
			"EnableVMware":false,
			"Office365MailQuota":0,
			"Hostname":"",
			"EnableDeduplication":true,
			"EnableMobileV2":false,
			"LdapDisableUser":-1,
			"LatestClientVersion":"",
			"EnableMSSQL":false,
			"VMwareQuotaType":"GUESTVM",
			"EnableLinuxBareMetal":false,
			"EnableLotusNotes":false,
			"VMwareQuota":0,
			"UserType":"PAID",
			"MobileAuthenticationSettings":{
				"MobileDeviceList":[],
				"Enable":false
			},
			"ClientType":"OBM",
			"EnableOracle":false,
			"RegistrationDate":1703141283712,
			"RecycleBinCompressed":0,
			"EnableExchangeMailbox":false,
			"QuotaList":[
				{
					"DestinationKey":"OBS",
					"Quota":52428800,
					"DestinationName":"AhsayCBS",
					"Enabled":true
				},
				{
					"DestinationKey":"-1700008764400",",
					"Quota":0,
					"DestinationName":"OneDrive-1",
					"Enabled":false
				},
				{
					"DestinationKey":"-1700025457535",
					"Quota":0,
					"DestinationName":"OneDrive-3",
					"Enabled":false
				}
			],
			"EnableCDP":false,
			"EnableInFileDelta":false,
			"SuspendPaidUserDate":"20241221",
			"MobileBackupSettings":{
				"DeviceList":[]
			},
			"MobileQuotaV2":0,
			"MobileUsage":{
				"MSExMailbox":0,
				"HostCount":1,
				"MSHyperVVM":0
				"VMwareCM":0
			},
			"EnableShadowCopy":false,
			"Language":"en",
			"Bandwidth":0,
			"StorageQuota":0,
			"LdapDeleteUser":-1,
			"EnableMySQL":false,
			"EnableOffice365Mail":false,
			"Notes":"",
			"OpenDirectQuota":0,
			"QuotaUsed":1,
			"EnableWinServer2008BareMetal":false,
			"RetainFile":0,
			"EnableQnatp":false,
			"QuotaType":"PER_DESTINATION_QUOTA",
			"EnableMsVm":false,
			"RetainSize":0,
			"RecycleBinFileNo":0,
			"LastBackupDate":0,
			"Contact":[],
			"EnableTibero":true,
			"AzureDestinationList":[],
			"UserId":"39367_new",
			"Alias":"",
			"ExchangeMailboxQuota":0,
			"EnableMsWinSysState":false,
			"SuspendPaidUser":false,
			"Online":false,
			"EnableMSExchange":false,
			"EnablePostgreSQL":false
		}
	]
}
Documentation