GetUser (v1,v2)

This API can be used to retrieve the information of a backup user.

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

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

v1 GetUser.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 GetUser.do

URL

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

Available Since Version: 9.7

Parameters

Return Values

JSON Objects

User

QuotaList

ContactList

EmailReportSettings

ForgotPasswordSettings

GroupPolicySettings

HostInfo

HostSet

LastSuccessfulLoginInfo

LdapSettings

ModuleSettings

PasswordHistory

MoveUserHomeRecord

ProxySettings

RoutineJobsSettings

SecuritySettings

TotalStatistics

UserLockSettings

UserSuspendSettings

windowsEventLogSettings

ModuleUsage

Example

INPUT

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

OUTPUT

{
	"Status":"OK",
	"Data":{
		"Timezone":"1098",
		"ClientRunVersion":"",
		"Owner":"",
		"HostCount":1,
		"SoftwareUpdateSettings":{
			"ReadOnly":false,
			"Enabled":true,
			"Id":""
		},
		"ModuleSettings":{
			"MobileQuota":0,
			"VMwareVMQuotaType":"GUESTVM",
			"VMwareVMQuota":0,
			"MobileEnabled":false,
			"DeltaMergeEnabled":false,
			"MSExchangeMailboxBackupEnabled":false,
			"DeduplicationEnabled":false,
			"MariaDBBackupEnabled":false,
			"OracleBackupEnabled":false,
			"QnapEnabled":false,
			"MSExchangeBackupEnabled":false,
			"OpenDirectEnabled":false,
			"VMwareBackupEnabled":false,
			"InFileDeltaEnabled":false,
			"MSHyperVVMQuota":0,
			"MySQLBackupEnabled":false,
			"MobileV2Quota":0,
			"LotusDominoBackupEnabled":false,
			"OpenDirectQuota":0,
			"MobileV2Enabled":false,
			"ReadOnly":false,
			"Office365MailQuota":0,
			"MSHyperVVMQuotaType":"GUESTVM",
			"NasClientEnabled":false,
			"MSSQLBackupEnabled":false,
			"MSExchangDAGServerQuota":0,
			"ShadoeProtectBackupEnabled":false,
			"MSWindowsSystemStateBackupEnabled":false,
			"MSHyperVBackupEnabled":false,
			"ShadowCopyEnabled":false,
			"LotusNotesBackupEnabled":false,
			"Id":"",
			"Office365MailEnabled":false,
			"CDPEnabled":false,
			"MSExMailboxQuota":0,
			"MSWindowsSystemBackupEnabled":false,
			"TiberoBackupEnabled": false,
			"LinuxBareMetalBackupEnabled": false,
			"GoogleWorkspaceEnabled": true,
			"GoogleWorkspaceQuota": 10,
			"ProxmoxVEBackupEnabled": true
		},
		"PasswordHistory":{
			"ReadOnly":false,
			"HistoryList":[],
			"PasswordLastModifiedTime":1687069108460,
			"Id":""
		},
		"RunDirectQuotaEnabled":false,
		"Name":"obm2",
		"AccessToken":"E1C9029954184F92B858280B9A6A3EBAA4F8809CA3E441C198ED5C2DE57918C3",
		"UserHome":"C:\\Program Files\\AhsayCBS\\user\\obm2",
		"LastSuccessfulLoginInfo":null,
		"WindowsEventLogSettings":{
			"ReadOnly":false,
			"LogLoginLogout":false,
			"LogInfo":false,
			"LogLicense":false,
			"Enabled":false,
			"LogUtilities":false,
			"LogError":false,
			"LogServices":false,
			"Id":"",
			"LogSoftwareUpdate":false,
			"LogProfile":false,
			"LogRestore":false,
			"LogBackup":false,
			"LogWarn":false,
			"LogBuy":false,
			"LogReport":false
		},
		"UserSuspendSettings":{
			"ReadOnly":false,
			"Enabled":false,
			"Id":"",
			"Date":0
		},
		"Status":"ENABLE",
		"ReadOnly":false,
		"LockedByMFA":false,
		"OpenDirectUsageCount":0,
		"EncodedName":"obm2",
		"MobileUserID":null,
		"Updated":false,
		"SavePassword":false,
		"BackupSetIdList":[],
		"Hostname":"jcvm.com",
		"MailboxUsage":0,
		"TrialDays":2592000000,
		"DoubleEncodedName":"obm2",
		"LastClientLoginTime":-1,
		"PlanAmount":-1,
		"UploadEncryptionKey":false,
		"GroupPolicySettings":{
			"ReadOnly":false,
			"UserGroupIDList":[-1],
			"ExcludeNetworkShare":false,
			"GroupQuota":0,
			"Id":"",
			"UserGroupQuota":0,
			"FileSizeLimit":0
		},
		"YearPlan":null,
		"LastShowingLicViolationTime":-1,
		"Id":"1687069108461",
		"RunDirectQuota":1,
		"File":"C:\\Program Files\\AhsayCBS\\con\\users.xml",
		"MobileAuthenticationSettings":{
			"Enable":false,
			"LastCountryCode":""
		},
		"ForgotPasswordSettings":{
			"ReadOnly":false,
			"Token":"",
			"RequestTime":-1,
			"Id":"",
			"ResetTime":-1
		},
		"LdapSettings":{
			"ReadOnly":false,
			"LdapUser":false,
			"LastDeleteTime":0,
			"LastDisableTime":0,
			"Id":"",
			"FirstAuthFailureTime":-1
		},
		"TopDir":"C:\\Program Files\\AhsayCBS\\user",
		"EnableAUA":true,
		"ClientType":"OBM",
		"RegistrationDate":1687069108460,
		"QuotaList":[
			{
				"DestinationKey":"OBS",
				"Quota":5368091200,
				"DestinationName":"AhsayCBS",
				"Enabled":true
			},
			{
				"DestinationKey":"-1687068833705",
				"Quota":0,
				"DestinationName":"Local-1",
				"Enabled":false
			},
			{
				"DestinationKey":"-1686815201815",
				"Quota":0,
				"DestinationName":"AhsayCBS-1",
				"Enabled":false
			}
		],
		"ProxySettings":{
			"ReadOnly":false,
			"Type":"",
			"Username":"",
			"Port":"",
			"Enabled":false,
			"Host":"",
			"Id":"",
			"Password":""
		},
		"HostQuotaEnabled":false,
		"AdGroups":[1],
		"ComputerNameDirList":null,
		"SecuritySettings":{
			"UserLockSettings":{
				"LockedTime":-1,
				"LastFailureTime":-1,
				"LoginFailureCount":0
			},
			"PhoneList":[],
			"Enable":false,
			"SendLimitSettings":{
				"LastSendTime":-1,
				"SendCount":0
			},
			"RecoverySettings":{
				"Token":"",
				"ExpiryTime":-1
			}
		},
		"AdGroup":"1",
		"SuspendPaidUserDate":"19700101",
		"MobileBackupSettings":{
			"DeviceList":[]
		},
		"HostSet":{
			"":""
		},
		"Locked":false,
		"CloudbackoGoDriveEnabled":false,
		"Language":"en",
		"ServerSettings":null,
		"HomeDir":"C:\\Program Files\\AhsayCBS\\user\\obm2",
		"Bandwidth":0,
		"StorageQuota":100,
		"class":"com.ahsay.obs.core.cxp.User",
		"HashedPassword":true,
		"SecurityIdentifier":"",
		"Notes":"",
		"Password":"BSJEajFurvvTdkh1V4+1Asgw6wjjIpkgK3rJ00y5S87B0=",
		"RemovingLogs":null,
		"NewBSetName":"BackupSet-0",
		"ImportDate":0,
		"UserLockSettings":{
			"LockedTime":-1,
			"LastFailureTime":-1,
			"LoginFailureCount":0
		},
		"TotalStatistics":{
			"TotalRecycleBinUncompressedSize":0,
			"DataAreaFileCount":0,
			"TotalRestoreCompressedSize":0,
			"TotalRecycleBinFileCount":0,
			"LastBackupCompressedSize":0,
			"DataAreaCompressedSize":0,
			"LastBackupUncompressedSize":0,
			"RetentionAreaFileCount":0,
			"RetentionAreaUncompressedSize":0,
			"DataAreaUncompressedSize":0,
			"TotalUploadCompressedSize":0,
			"LastBackupFileCount":0,
			"TotalUploadFileCount":0,
			"TotalRestoreFileCount":0,
			"TotalRecycleBinCompressedSize":0,
			"RetentionAreaCompressedSize":0
		},
		"QuotaType":"PER_DESTINATION_QUOTA",
		"V6File":"C:\\Program Files\\AhsayCBS\\user\\obm2\\db\\Profile.xml",
		"RoutineJobSettings":{
			"ReadOnly":false,
			"QuotaRemindPercentage":0,
			"Id":"",
			"InactiveReportLastSentTime":-1
		},
		"LongLoginName":"obm2",
		"ContactList":[
			{
				"ReadOnly":false,
				"Company":"",
				"Phone1":"",
				"Email":"obm2@example.com",
				"Address":"",
				"EmailCertificate":"",
				"Phone2":"",
				"EncryptEmail":false,
				"Website":"",
				"Id":"1687069108462",
				"Name":""
			}
		],
		"EmailReportSettings:{
			"SendBkpRpt":false,
			"ReadOnly":false,
			"Usage":0,
			"Email":"",
			"ReportSenderEmail":"",
			"SmtpAuthUser":"",
			"Enabled":false,
			"SendBkpRptMode":"",
			"SmtpHostName":"",
			"MissedBkpInterval":0,
			"SmtpProtocol":"",
			"Id":"",
			"SmtpPort":"",
			"SendMissedBkpRpt":false,
			"SendStorageAlert":false,
			"SmtpAuthPwd":""
		},
		"LastLoginTime":0,
		"Type":"PAID",
		"UsedHostQuota":0,
		"Alias":"",
		"UserId":"obm2",
		"FullName":null,
		"PreV7":false,
		"TrialExpiryDate":0,
		"MoveUserHomeRecord":null,
		"HostQuota":1,
		"HostInfo":""
	}			
}