Group Policy

This subcategory deals with configurations for Group Policies and User Groups, including the addition and deletion of either one, as well as the modification of already existing Group Policies or User Groups relative to their effects on Users.

• AddUserGroup
• DeletePolicyGroup
• DeletePolicyGroupFromUserGroup
• DeleteUserFromUserGroup
• DeleteUserGroup
• ListPolicyGroups (v1,v2)
• ListUserGroups
• ModifyUserGroup
• UpdatePolicyGroup (v1,v2)
• AddPolicyGroup
• AddPolicyGroupToUserGroup

AddUserGroup

This API lets you add a new User Group and allocate users to it.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

EditBillingContactBean

Examples

Example 1

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"UserGroupName":"user-group"
}

OUTPUT 1

{
	"Status":"OK",
	"ID":"1447039919940"
}

OUTPUT 2 - User Group already in use

{
	"Status":"Error",
	"Message":"The user group name is already in use.",
	"ExptType":"java.lang.Exception"
}

Example 2: Add User Group in Assign Policy

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"UserGroupName":"test-usergroup",
	"PolicyIDList":"139811529749"
}

OUTPUT

{
	"Status":"OK",
	"ID":"1447039919940"
}

DeletePolicyGroup

This API allows you to delete a policy group.

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

• Backup/Restore > Users, Groups & Policies > Policy Group

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456",
	"ID":"1496989829495"
}

OUTPUT

{
	"Status":"OK"
}

DeletePolicyGroupFromUserGroup

This API allows you to delete a policy group.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456",
	"UserGroupID":"1497233669967",
	"PolicyGroupID":"1497233409042"
}

OUTPUT 1

{
	"Status":"OK"
}

OUTPUT 2 - Policy group does not exist

{
	"Status":"Error",
	"Message":"Policy group does not exist",
	"ExptType":"org.json.JSONException"
}

DeleteUserFromUserGroup

This API allows you to delete a users in a user group.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456",
	"UserGroupID":"1497233669967",
	"UserIdList":"1497233409042, 1496977596356"
}

OUTPUT 1

{
	"Status":"OK"
}

OUTPUT 2 - User does not exist

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

DeleteUserGroup

This API allows you to delete a user group and all its information.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

Example

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456",
	"ID":"1497232492006"
}

OUTPUT 1

{
	"Status":"OK"
}

OUTPUT 2 - User group does not exist

{
	"Status":"Error",
	"Message":"[Error] Parameter UserGroupID, 1497232492006 does not exist.",
	"ExptType":"com.ahsay.obs.core.dbs.Y"
}

ListPolicyGroups (v1,v2)

This API can be used to retrieve the group policy settings of a backup user.

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

• Backup / Restore > Users, Groups & Policies > Policy Group

v1 ListPolicyGroups.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 ListPolicyGroups.do

For features related to Quota Management, administrator needs to utilize v2 ListPolicyGroups.do

URL

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

Available Since Version: 9.7

Parameters

Return Values

JSON Objects

NameInfo

PolicyGroup

Other Parameters Under Policy Group

PreemptedValues

GranularRestoreSettingsList

VmwareSettingsList

VMwareSetting

OpenDirectSettingsList

AppliedValueSettings

VolumeShadowCopySettingsList

VolumeShadowCopySetting

AllowedIPSettingsList

AllowedIPSetting

AllowedIP

SourceShortcutSettingsList

FollowLinkSettingsList

FollowLinkSetting

InFileDeltaSettingsList

InFileDeltaSetting

WeeklyInFileDeltaSchedule

MonthlyInFileDeltaSchedule

CompressionsSettingsList

CommandSetting

WinUserAuthSettingsList

WinUserAuthSetting

SourceShortcutSettingsList

MswindowsSystemStateSettingsList

MswindowsSystemStateSetting

DestinationSettingsList

DestinationSetting

Destination

BandwidthControlSettingsList

BandwidthControlSetting

BandwidthControlSetting

NameSettingsList

NameSetting

MySQLSettingsList

MySQLSetting

FilePermissionsSettingsList

FilePermissionsSetting

RetentionPolicySettingsList

RetentionPolicySetting

AdvancedRetentionPolicy

ShadowProtectSettingsList

ShadowProtectSetting

AdvancedSettingsList

AdvancedSetting

CommandSettingsList

CommandSetting

Command

TemporaryDirectorySettingsList

OracleSettingsList

OracleSetting

LotusNotesSettingsList

LotusNotesSetting

ReminderSettingsList

ReminderSetting

FilterSettingsList

FilterSetting

Filter

Pattern

MswindowsSystemSettingsList

MswindowsSystemSetting

LotusDominoSettingsList

LotusDominoSetting

TiberoSettingsList

TiberoSetting

ScheduleSettingsList

ScheduleSetting

DailyScheduleList

WeeklyScheduleList

MonthlyScheduleList

CustomScheduleList

EncryptionSettingsList

EncryptionSetting

ArchivedLogDeletionSettingsList

ArchivedLogDeletionSetting

CdpSettingsList

CdpSetting

CdpBackupControl

RecycleBinSettingsList

RecycleBinSetting

UserSettings

MaximumBackupSetsSettings

HostLimitSettings

RunDirectLimitSettings

AdvertisementSettings

BackupDestinationSettings

CustomDestinationList (BackupDestinationSettings)

LogonSettings

EncryptionKeySettings

EmailReportSettings

UserQuotaSettings

QuotaList (UserQuotaSettings)

QuotaSettings

CloudBackupSourceSettings

CloudSourceList (CloudBackupSourceSettings)

PasswordSettings

SharedQuotaSettings

QuotaList (SharedQuotaSettings)

GuiSettings

Privilege

PreemptedBackupSetSettings

BackupSetSettings

ExcludeFileSettings

BackupSetTypeSettings

DefaultValues

DeduplicationSettingsList

Array - Deduplication Settings (Policy)

LoginWebConsoleSettings

Example

Example 1

INPUT

{
	"SysUser":"api",
	"SysPwd":"abc123",
	"LoginName":"username",
	"PolicyGroupNameOnly":true
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"PolicyGroupName":"Default settings",
			"PolicyGroupID":"2"
		}
	]
}

Example 2 - Snippet Example (Deduplication)

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"LoginName":"username"
}

OUTPUT

{
	
	
“@class”:”com.ahsay.obx.cxp.cpd.policy.values.deduplication.Deduplication
Settings”,
		"MigrateData":false,
		"AppliedValueSettings":{
			"Type":"default",
			"@class":"com.ahsay.obx.cxp.cpf.policy.values.AppliedValueSettings",
			"Os":"",
			"Version":"",
			"Mode":"",
			"BackupMode":"",
			"AppliedModuleSettingsList":[
			{
				"Enable":false,
				"Name":"FILE"
			},
			{
				"Enable":false,
				"Name":"Lotus Domino"
			},
			{
				"Enable":false,
				"Name":"Notes"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Server"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Mail (MAPI)"
			},
			{
				"Enable":false,
				"Name":"Microsoft SQL Server"
			},
			{
				"Enable":true,
				"Name":"Microsoft Windows Virtualization"
			},
			{
				"Enable":false,
				"Name":"Microsoft Windows System Backup"
			},
			{
				"Enable":false,
				"Name":"MySQL"
			},
			{
				"Enable":false,
				"Name":"MariaDB"
			},
			{
				"Enable":false,
				"Name":"Oracle Database Server"
			},
			{
				"Enable":false,
				"Name":"ShadowProtect Bare Metal"
			},
			{
				"Enable":false,
				"Name":"System State"
			},
			{
				"Enable":true,
				"Name":"VMware Virtualization"
			},
			{
				"Enable":false,
				"Name":"Cloud File"
			},
			{
				"Enable":false,
				"Name":"Office 365 Exchange Online"
			}
		],
		"Id":"1434946034923",
		"Name":"Default deduplication settings - VMware & Hyper-V"
		},
		"Scope":"ALL_FILES",
		"Enabled":true,
		"SettingsMigrated":true,
		"BlockSize":524288
...	
}

Example 3 - Snippet Example (RecycleBinSettingsList)

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"LoginName":"username",
	"ID":"1692164125127"
}

OUTPUT

{
	"RecycleBinSettingsList":{
		"Enable":true,
		"List":[
		{
		
"@class”:”com.ahsay.obx.cxp.cpf.policy.values.others.RecycleBinSettings",
			"AppliedValueSettings":{
				"Destination":"".
				"Type":"default",
				
"@class”:”com.ahsay.obx.cxp.cpf.policy.values.AppliedValueSettings",
			"Os":"",
			"Version":"",
			"Mode":"",
			"BackupMode":"",
			"AppliedModuleSettingsList":[
			{
				"Enable":true,
				"Name":"FILE"
			},
			{
				"Enable":false,
				"Name":"Lotus Domino"
			},
			{
				"Enable":false,
				"Name":"Notes"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Server"
			},
			{
				"Enable":false,
				"Name":"Microsoft Exchange Mail (MAPI)"
			},
			{
				"Enable":false,
				"Name":"Microsoft SQL Server"
			},
			{
				"Enable":false,
				"Name":"Microsoft Windows Virtualization"
			},
			{
				"Enable":false,
				"Name":"Microsoft Windows System Backup"
			},
			{
				"Enable":false,
				"Name":"MySQL"
			},
			{
				"Enable":false,
				"Name":"MariaDB"
			},
			{
				"Enable":false,
				"Name":"Oracle Database Server"
			},
			{
				"Enable":false,
				"Name":"ShadowProtect Bare Metal"
			},
			{
				"Enable":false,
				"Name":"System State"
			},
			{
				"Enable":false,
				"Name":"VMware Virtualization"
			},
			{
				"Enable":false,
				"Name":"Cloud File"
			},
			{
				"Enable":false,
				"Name":"Office 365 Exchange Online"
			}
		],
		"Id":"1692164125127",
		"Name":"Setting1"
	},
	"Enabled":true,
	"RetentionPeriod":8
}

ListUserGroups

This API can be used to retrieve the information of a User Group.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

JSON Objects

UserGroupBasicInfo

UserGroupFullInfo

User

Policy

Example

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"UserGroupOnly":true
}

OUTPUT

{
	"Status":"OK",
	"Data":[
		{
			"Type":"BACKUP_USER",
			"Owner":"",
			"ID":"1",
			"Name":"All Users"
		}
	]
}

ModifyUserGroup

This API lets you modify the name of the User Group, add users or delete user to / from a User Group.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"ID":"1447039919940",
	"UserIdList":"user",
	"Mode":"D"
}

OUTPUT

{
	"Status":"OK"
}

OUTPUT - User does not exist

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

Example 2: Incorrect parameter mode

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"ID":"1447039919940",
	"UserIdList":"user",
	"Mode":"S"
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter Mode must either be A or D!",
	"ExptType":"com.ahsay.obs.core.dbs.c"
}

UpdatePolicyGroup (v1,v2)

This API can be used to update settings of a Policy Group.

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

• Backup / Restore > Users, Groups & Policies > Policy Group

The Policy Group ID can be created using AddPolicyGroup.do or can be found from the AhsayCBS Policy Group page, by looking at the URL. Example: https://CBS>EXAMPLE.COM/cbs/obs/policy/EditPolicy.do?id=1632367172249

v1 UpdatePolicyGroup.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 UpdatePolicyGroup.do

For features related to Quota Management, administrator needs to utilize v2 UpdatePolicyGroup.do

URL

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

Available Since Version: 9.5

Parameters

Return Values

JSON Objects

PreemptedValues

AppliedValueSettings

CloudSourceList

TiberoSettingsList

TiberoSetting

PostgreSQLSettingsList

PostgreSQLSetting

DefaultValues

Examples

Example 1

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"Name":"Default settings",
	"ID":"2",
	"Owner":"",
	"UserSettings":{
		"HostLimitSettings":{
			"Enable":true,
			"MaxHost":45
		}
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 2: Deduplication (snippet)

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"ID":"2",
	"Owner":"",
	"DefaultValues":{
		"DeduplicationSettingsList":{
			"Enable":true,
			"List":[
				{
				
"@class”:”com.ahsay.obx.cxp.cpf.policy.values.deduplication.DeduplicationSettings",
					"MigrateData":false,
					"AppliedValueSettings":{
						"Type":"default",
						
"@class”:”com.ahsay.obx.cxp.cpf.policy.values.AppliedValuesSettings",
						"Os":"",
						"Mode":"",
						"BackupMode":"",
						"AppliedModuleSettingsList":[
							{
								"Enable":false,
								"Name":"FILE"
							},
							{
								"Enable":false,
								"Name":"Lotus Domino"
							},
							{
								"Enable":false,
								"Name":"Lotus Notes"
							},
							{
								"Enable":false,
								"Name":"Microsoft Exchange Server"
							},
							{
								"Enable":false,
								"Name":"Microsoft Exchange Mail (MAPI)"
							},
							{
								"Enable":false,
								"Name":"Microsoft SQL Server"
							},
							{
								"Enable":false,
								"Name":"Microsoft Windows Virtualization"
							},
							{
								"Enable":false,
								"Name":"Microsoft Windows System Backup"
							},
							{
								"Enable":false,
								"Name":"MySQL"
							},
							{
								"Enable":false,
								"Name":"MariaDB"
							},
							{
								"Enable":false,
								"Name":"Oracle Database Server"
							},
							{
								"Enable":false,
								"Name":"ShadowProtect Bare Metal"
							},
							{
								"Enable":false,
								"Name":"System State"
							},
							{
								"Enable":false,
								"Name":"VMware Virtualization"
							},
							{
								"Enable":false,
								"Name":"Cloud File"
							},
							{
								"Enable":false,
								"Name":"Office 365 Exchange Online"
							},
							"Id":"1434946034923",
							"Name":"Default deduplication settings - VMware & Hyper-V"
						}
					]
				}
		}
	}
}

OUTPUT

{
	"Status":"OK"
}

Example 3

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Name":"api-test-policy",
	"ID":"1632367172249",
	"Owner":"",
	"PreemptedValues":{
		"VmwareSettingsList":{
			"Enable":false,
			"List": []
		},
		"VolumeShadowCopySettingsList":{
			"Enable":false,
			"List": []
		},
		"AllowedIPSettingsList":{
			"Enable":false,
			"List": []
		},
		"FollowLinkSettingsList":{
			"Enable":false,
			"List": []
		},
		"InFileDeltaSettingsList":{
			"Enable":false,
			"List": []
		},
		"CompressionsSettingsList":{
			"Enable":false,
			"List": []
		},
		"WinUserAuthSettingsList":{
			"Enable":false,
			"List": []
		},
		"FileSettingsList":{
			"Enable":false,
			"List": []
		},
		"MswindowsSystemStateSettingsList":{
			"Enable":false,
			"List": []
		},
		"DestinationSettingsList":{
			"Enable":false,
			"List": []
		},
		"BandwidthControlSettingsList":{
			"Enable":false,
			"List": []
		},
		"NameSettingsList":{
			"Enable":false,
			"List": []
		},
		"RetentionPolicySettingsList":{
			"Enable":false,
			"List": []
		},
		"FilePermissionsSettingsList":{
			"Enable":false,
			"List": []
		},
		"MySQLSettingsList":{
			"Enable":false,
			"List": []
		},
		"ShadowProtectSettingsList":{
			"Enable":false,
			"List": []
		},
		"AdvancedSettingsList":{
			"Enable":false,
			"List": []
		},
		"CommandSettingsList":{
			"Enable":false,
			"List": []
		},
		"TemporaryDirectorySettingsList":{
			"Enable":false,
			"List": []
		},
		"OracleSettingsList":{
			"Enable":false,
			"List": []
		},
		"ReminderSettingsList":{
			"Enable":false,
			"List": []
		},
		"LotusNotesSettingsList":{
			"Enable":false,
			"List": []
		},
		"FilterSettingsList":{
			"Enable":false,
			"List": []
		},
		"MswindowsSystemSettingsList":{
			"Enable":false,
			"List": []
		},
		"LotusDominoSettingsList":{
			"Enable":false,
			"List": []
		},
		"ScheduleSettingsList":{
			"Enable":false,
			"List": []
		},
		"ArchivedLogDeletionSettingsList":{
			"Enable":false,
			"List": []
		},
		"EncryptionSettingsList":{
			"Enable":false,
			"List": []
		},
		"CdpSettingsList":{
			"Enable":false,
			"List": []
		}
	},
	"UserSettings":{
		"MaximumBackupSetsSettings":{
			"MaximumBackupSetsPerUser":10,
			"Enable":false
		},
		"BackupDestinationSettings":{
			"ApplicationName":"",
			"CustomDestinationList":[
				{
					"ChinaClientID":"e71a1234-1234-1234-b2f4-ccf1aa830a78",
					"@class":"com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizDestination",
					"ChinaRedirectURI":"https://backupserverserver/register/oauth2-office365.jsp",
					"Enable":true,
					"ClientID":"d349b19f-0a90-1234-1234-0caa8114da04",
					"RedirectURI":"https://backupserverserver/register/oauth2-office365.jsp",
					"Name":"OneDrive4Biz"
				}
			],
			"SystemDestIDList":[],
			"Enable":false,
			"SystemDestinationList":[]
		},
		"QuotaSettings":{
			"SharedQuota":10737418240,
			"MaxPercentage":50,
			"Enable":true,
			"Compress":true,
			"SharedQuotaEnable":false
		},
		"CloudBackupSourceSettings":{
			"Enable":true,
			"CloudSourceList":[
				{
					"ChinaClientID":"e71a1234-1234-1234-b2f4-ccf1aa830a78",
					"@class":"com.ahsay.obx.cxp.cpf.policy.userSettings.OneDrive4BizSource",
					"ChinaRedirectURI":"https://backupserver/register/oauth2-office365.jsp",
					"ClientID":"d349b19f-0a90-1234-1234-0caa8114da04",
					"RedirectURI":"https://backupserver/register/oauth2-office365.jsp",
					"Name":"OneDrive4Biz"
				}
			]
		},
		"EncryptionKeySettings":{
			"Enable":false,
			"Upload":false
		},
		"EmailReportSettings":{
			"ContactList":[],
			"SendInactiveBSetReport":false,
			"Enable":false,
			"ConsolidatedReportSendMin":0,
			"SendIndividualReport":false,
			"SendConsolidatedReport":false,
			"InactiveBSetReportSendDay":30,
			"ConsolidatedReportSendHour":0
		},
		"PasswordSettings":{
			"EnforcePasswordHistory":true,
			"MinimumLength":6,
			"SpecialCharacters":true,
			"Uppercase":true,
			"Enable":false,
			"Lowercase":true,
			"Number":true,
			"Type":"DEFAULT",
			"PasswordAge":90,
			"MinimumLengthEnabled":true,
			"Regex":""
		},
		"LogonSettings":{
			"InvalidLoginAttemptPeriod":30,
			"Enable":false,
			"NumOfInvalidLogin":3,
			"BlockMinute":60,
			"BlockType":"MINUTE",
			"BlockHour":24
		},
		"Type":"BACKUP_USER",
		"PreemptedBackupSetSettings":{
			"PreemptedBackupSetList":[]
		},
		"GuiSettings":{
			"PrivilegeList":[
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Backup",
					"EnableRead":true,
					"Id":"M-10001",
					"DisplayName":"Backup"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Restore",
					"EnableRead":true,
					"Id":"M-10002",
					"DisplayName":"Restore"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"BackupSets",
					"EnableRead":true,
					"Id":"M-10003",
					"DisplayName":"Backup Sets"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Settings",
					"EnableRead":true,
					"Id":"M-10004",
					"DisplayName":"Settings"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Report",
					"EnableRead":true,
					"Id":"M-10005",
					"DisplayName":"Report"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Utilities",
					"EnableRead":true,
					"Id":"M-10006",
					"DisplayName":"Utilities"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Profile",
					"EnableRead":true,
					"Id":"M-10007",
					"DisplayName":"Profile"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Language",
					"EnableRead":true,
					"Id":"M-10008",
					"DisplayName":"Language"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Information",
					"EnableRead":true,
					"Id":"M-10009",
					"DisplayName":"Information"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"Advertisement",
					"EnableRead":true,
					"Id":"M-10010",
					"DisplayName":"Advertisement"
				},
				{
					"PrivilegeGroup":"MainMenu",
					"PolicyName":"SocialMedia",
					"EnableRead":true,
					"Id":"M-10011",
					"DisplayName":"Links to Social Media"
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"ProfileGeneralTab",
					"EnableRead":true,
					"Id":"P-10001",
					"DisplayName":"General Tab"
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"ProfileGeneralSettings",
					"EnableRead":true,
					"Id":"P-10002",
					"DisplayName":"General Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"ContactsTab",
					"EnableRead":true,
					"Id":"P-10003",
					"DisplayName":"Contacts Tab"
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"ContactsSettings",
					"EnableRead":true,
					"Id":"P-10004",
					"DisplayName":"Contacts Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"TimezoneTab",
					"EnableRead":true,
					"Id":"P-10005",
					"DisplayName":"Timezone Tab"
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"TimezoneSettings",
					"EnableRead":true,
					"Id":"P-10006",
					"DisplayName":"Timezone Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"PasswordTab",
					"EnableRead":true,
					"Id":"P-10007",
					"DisplayName":"Password Tab"
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"PasswordSettings",
					"EnableRead":true,
					"Id":"P-10008",
					"DisplayName":"Password Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"EncryptionRecoveryTab",
					"EnableRead":true,
					"Id":"P-10009",
					"DisplayName":"Encryption Recovery Tab"
				},
				{
					"PrivilegeGroup":"Profile",
					"PolicyName":"EncryptionRecoverySettings",
					"EnableRead":true,
					"Id":"P-10010",
					"DisplayName":"Encryption Recovery Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsName",
					"EnableRead":true,
					"Id":"BS-10003",
					"DisplayName":"General Settings - Name",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsIBMDomino",
					"EnableRead":true,
					"Id":"BS-10004",
					"DisplayName":"General Settings - IBM Domino",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsIBMNotes",
					"EnableRead":true,
					"Id":"BS-10005",
					"DisplayName":"General Settings - IBM Notes",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsMSExchangeServer",
					"EnableRead":true,
					"Id":"BS-10006",
					"DisplayName":"General Settings - MS Exchange Server",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsMSHyper-V",
					"EnableRead":true,
					"Id":"BS-10007",
					"DisplayName":"General Settings - MS Hyper-V",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsMSSQLServer",
					"EnableRead":true,
					"Id":"BS-10008",
					"DisplayName":"General Settings - MSSQL Server",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsWindowsSystemBackup",
					"EnableRead":true,
					"Id":"BS-10009",
					"DisplayName":"General Settings - Windows System Backup",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsWindowsSystemStateBackup",
					"EnableRead":true,
					"Id":"BS-10010",
					"DisplayName":"General Settings - Windows System State Backup",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsMySQLServer",
					"EnableRead":true,
					"Id":"BS-10011",
					"DisplayName":"General Settings - MySQL Server",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsOracleDatabaseServer",
					"EnableRead":true,
					"Id":"BS-10012",
					"DisplayName":"General Settings - Oracle Database Server",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsVMwareHost",
					"EnableRead":true,
					"Id":"BS-10013",
					"DisplayName":"General Settings - VMware Host",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsShadowProtect",
					"EnableRead":true,
					"Id":"BS-10014",
					"DisplayName":"General Settings - Shadow Protect",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralSettingsWindowsUserAuthentication",
					"EnableRead":true,
					"Id":"BS-10015",
					"DisplayName":"General Settings - Windows User Authentication",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"SourceTab",
					"EnableRead":true,
					"Id":"BS-10016",
					"DisplayName":"Source Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"SourceSettingsBackupSource",
					"EnableRead":true,
					"Id":"BS-10017",
					"DisplayName":"Source Settings - BackupSource",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"SourceSettingsFilter",
					"EnableRead":true,
					"Id":"BS-10018",
					"DisplayName":"Source Settings - Filter",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"BackupScheduleTab",
					"EnableRead":true,
					"Id":"BS-10020",
					"DisplayName":"Backup Schedule Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"BackupScheduleSettings",
					"EnableRead":true,
					"Id":"BS-10021",
					"DisplayName":"Backup Schedule Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"ContinuousBackupTab",
					"EnableRead":true,
					"Id":"BS-10022",
					"DisplayName":"Continuous Backup Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"ContinuousBackupSettings",
					"EnableRead":true,
					"Id":"BS-10023",
					"DisplayName":"Continuous Backup Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"DestinationTab",
					"EnableRead":true,
					"Id":"BS-10024",
					"DisplayName":"Destination Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":DestinationSettings",
					"EnableRead":true,
					"Id":"BS-10025",
					"DisplayName":"Destination Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"InFileDeltaTab",
					"EnableRead":true,
					"Id":"BS-10026",
					"DisplayName":"In-File Delta Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"InFileDeltaSettings",
					"EnableRead":true,
					"Id":"BS-10027",
					"DisplayName":"In-File Delta Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"RetentionPolicyTab",
					"EnableRead":true,
					"Id":"BS-10028",
					"DisplayName":"Retention Policy Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"RetentionPolicySettings",
					"EnableRead":true,
					"Id":"BS-10029",
					"DisplayName":"Retention Policy Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"CommandLineToolTab",
					"EnableRead":true,
					"Id":"BS-10030",
					"DisplayName":"Command Line Tool Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"CommandLineToolSettings",
					"EnableRead":true,
					"Id":"BS-10031",
					"DisplayName":"Command Line Tool Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"ReminderTab",
					"EnableRead":true,
					"Id":"BS-10032",
					"DisplayName":"Reminder Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"ReminderSettings",
					"EnableRead":true,
					"Id":"BS-10033",
					"DisplayName":"Reminder Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"BandwidthControlTab",
					"EnableRead":true,
					"Id":"BS-10034",
					"DisplayName":"Bandwidth Control Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"BandwidthControlSettings",
					"EnableRead":true,
					"Id":"BS-10035",
					"DisplayName":"Bandwidth Control Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersTab",
					"EnableRead":true,
					"Id":"BS-10038",
					"DisplayName":"Others Tab"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersSettingsTemporaryDirectory",
					"EnableRead":true,
					"Id":"BS-10039",
					"DisplayName":"Others Settings - Temporary Directory",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersSettingsFollowLink",
					"EnableRead":true,
					"Id":"BS-10040",
					"DisplayName":"Others Settings - Follow Link",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersSettingsVolumeShadowCopy",
					"EnableRead":true,
					"Id":"BS-10041",
					"DisplayName":"Others Settings - Volume Shadow Copy",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersSettingsFilePermissions",
					"EnableRead":true,
					"Id":"BS-10042",
					"DisplayName":"Others Settings - File Permissions",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersSettingsArchivedLogDeletion",
					"EnableRead":true,
					"Id":"BS-10043",
					"DisplayName":"Others Settings - Archived Log Deletion",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersSettingsCompressions",
					"EnableRead":true,
					"Id":"BS-10044",
					"DisplayName":"Others Settings - Compressions",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"OthersSettingsEncryption",
					"EnableRead":true,
					"Id":"BS-10045",
					"DisplayName":"Others Settings - Encryption",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"Settings",
					"PolicyName":"ProxyTab",
					"EnableRead":true,
					"Id":"S-10001",
					"DisplayName":"Proxy Tab"
				},
				{
					"PrivilegeGroup":"Settings",
					"PolicyName":"ProxySettings",
					"EnableRead":true,
					"Id":"S-10002",
					"DisplayName":"Proxy Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"Settings",
					"PolicyName":"WindowsEventLogTab",
					"EnableRead":true,
					"Id":"S-10005",
					"DisplayName":"Windows Event Log Tab"
				},
				{
					"PrivilegeGroup":"Settings",
					"PolicyName":"WindowsEventLogSettings",
					"EnableRead":true,
					"Id":"S-10006",
					"DisplayName":"Windows Event Log Settings",
					"EnableWrite":true
				},
				{
					"PrivilegeGroup":"Utilities",
					"PolicyName":"DataIntegrityCheck",
					"EnableRead":true,
					"Id":"U-10001",
					"DisplayName":"Data Integrity Check"
				},
				{
					"PrivilegeGroup":"Utilities",
					"PolicyName":"SpaceFreeingUp",
					"EnableRead":true,
					"Id":"U-10002",
					"DisplayName":"Space Freeing Up"
				},
				{
					"PrivilegeGroup":"Utilities",
					"PolicyName":"DeleteBackupData",
					"EnableRead":true,
					"Id":"U-10003",
					"DisplayName":"Delete Backup Data"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"AddAndRemove",
					"EnableRead":true,
					"Id":"BS-10001",
					"DisplayName":"Add and Remove Backup Set"
				},
				{
					"PrivilegeGroup":"BackupSets",
					"PolicyName":"GeneralTab",
					"EnableRead":true,
					"Id":"BS-10002",
					"DisplayName":"General Tab"
				}
			]
		},
		"ID":"1446023471399",
		"BackupSetSettings":{
			"ExcludeFileSettings":{
				"LastModifiedPeriod":10,
				"FileSize":10737418240,
				"ExcludeMappedDrive":true,
				"ExcludeLastModified":true,
				"LastModifiedPeriodType":"YEAR",
				"LastModifiedType":"PERIOD",
				"Enable":false,
				"LastModifiedDate":-1,
				"ExcludeFileSize":true
			}
		},
		"DefaultValues":{
			"VmwareSettingsList":{
				"Enable":false,
				"List":[]
			},
			"VolumeShadowCopySettingsList":{
				"Enable":false,
				"List":[]
			},
			"AllowedIPSettingsList":{
				"Enable":false,
				"List":[]
			},
			"FollowLinkSettingsList":{
				"Enable":false,
				"List":[]
			},
			"InFileDeltaSettingsList":{
				"Enable":false,
				"List":[]
			},
			"CompressionsSettingsList":{
				"Enable":false,
				"List":[]
			},
			"WinUserAuthSettingsList":{
				"Enable":false,
				"List":[]
			},
			"FileSettingsList":{
				"Enable":false,
				"List":[]
			},	
			"MswindowsSystemStateSettingsList":{
				"Enable":false,
				"List":[]
			},
			"DestinationSettingsList":{
				"Enable":false,
				"List":[]
			},
			"BandwidthControlSettingsList":{
				"Enable":false,
				"List":[]
			},
			"NameSettingsList":{
				"Enable":false,
				"List":[]
			},
			"RetentionPolicySettingsList":{
				"Enable":false,
				"List":[]
			},
			"FilePermissionsSettingsList":{
				"Enable":false,
				"List":[]
			},
			"MySQLSettingsList":{
				"Enable":false,
				"List":[]
			},
			"ShadowProtectSettingsList":{
				"Enable":false,
				"List":[]
			},
			"AdvancedSettingsList":{
				"Enable":false,
				"List":[]
			},
			"CommandSettingsList":{
				"Enable":false,
				"List":[]
			},
			"TemporaryDirectorySettingsList":{
				"Enable":false,
				"List":[]
			},
			"ReminderSettingsList":{
				"Enable":false,
				"List":[]
			},
			"LotusNotesSettingsList":{
				"Enable":false,
				"List":[]
			},
			"FilterSettingsList":{
				"Enable":false,
				"List":[]
			},
			"MswindowsSystemSettingsList":{
				"Enable":false,
				"List":[]
			},
			"LotusDominoSettingsList":{
				"Enable":false,
				"List":[]
			},
			"ScheduleSettingsList":{
				"Enable":false,
				"List":[]
			},
			"ArchivedLogDeletionSettingsList":{
				"Enable":false,
				"List":[]
			},
			"EncryptionSettingsList":{
				"Enable":false,
				"List":[]
			},
			"CdpSettingsList":{
				"Enable":false,
				"List":[]
			}
		}
}

OUTPUT 1: If no errors

{
	"Status":"OK"
}

OUTPUT 2: If v1 UpdatePolicyGroup parameter FileSettingsList was in the input

{
	"Status":"Error",
	"Message":"FileSettingsList” is deprecated. It is only supported in UpdatePolicyGroup v1 API. Please use ‘SourceShortcutSettingsList’ instead",
	"ExptType":"java.lang.Exception"
}

OUTPUT 3: If ClientID is empty from the input

{
	"Status":"Error",
	"Message":"ClientID cannot be empty in OneDrive4Biz of CustomDestinationList!",
	"ExptType":"java.lang.Exception"
}

OUTPUT 4: If RedirectURI is empty from the input

{
	"Status":"Error",
	"Message":"RedirectURI cannot be empty in OneDrive4Biz of CustomDestinationList!",
	"ExptType":"java.lang.Exception"
}

OUTPUT 5: If ChinaClientID is empty from the input

{
	"Status":"Error",
	"Message":"ChinaClientID cannot be empty in OneDrive4Biz of CustomDestinationList!",
	"ExptType":"java.lang.Exception"
}

OUTPUT 6: If ChinaRedirectURI is empty from the input

{
	"Status":"Error",
	"Message":"ChinaRedirectURI cannot be empty in OneDrive4Biz of CustomDestinationList!",
	"ExptType":"java.lang.Exception"
}

Example 4: Incorrect Value

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"ID":"2",
	"UserSettings":{
		"UserQuotaSettings":{
			"QuotaType":"perDestinationQuota",
			"StorageQuota":0
		}
	}
}

OUTPUT

{
	"Status":"Error",
	"Message":"Invalid value. 'QuotaType' must be 'TOTAL_QUOTA' or 'PER_DESTINATION_QUOTA'.",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

Example 5: Incorrect Value

INPUT

{
	"SysUser":"api_user",
	"SysPwd":"qWeRtY123456!@#$%",
	"ID":"2",
	"UserSettings":{
		"UserQuotaSettings":{
			"QuotaType":"TOTAL_QUOTA",
			"StorageQuota":0
		}
	}
}

OUTPUT

{
	"Status":"Error",
	"Message":"Invalid value 'StorageQuota'. Error: Must be a positive number.",
	"ExptType":"java.lang.Exception"
}

AddPolicyGroup

This API lets you add (create) a new Policy Group and optionally allocate it to User Group(s), returned is the PolicyGroupID that can be used with UpdatePolicyGroup.do.

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

• Backup / Restore > Users, Groups & Policies > Policy Group

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Name":"Default settings",
	"Owner":"",
	"UserGroupIDList":["1"]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter Name, Default settings, already exists!",
	"ExptType":"com.ahsay.cbs.mT"
}

Example 2

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Name":"UG Test",
	"Owner":"test",
	"UserGroupIDList":["1686621934417"]
}

OUTPUT

{
	"Status":"OK",
	"PolicyGroupID":"1686621934417"
}

Example 3

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Name":"UG Test",
	"Owner":"test",
	"UserGroupIDList":["1","3"]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter UserGroupID, 3 is not a 13-digit format!",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

Example 4

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Name":"UG Test",
	"Owner":"test",
	"UserGroupIDList":[0]
}

OUTPUT

{
	"Status":"OK",
	"Message":"JSONArray[0] is not a String (class java.lang.Integer : 0).",
	"ExptType":"org.json.JSONException"
}

Example 5

INPUT

{
	"SysUser":"api",
	"SysPwd":"pwd",
	"Name":"UG Test",
	"Owner":0,
	"UserGroupIDList":["1"]
}

OUTPUT

{
	"Status":"OK",
	"Message":"[Error] Parameter Owner ‘0’ is not a valid owner.",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

AddPolicyGroupToUserGroup

This API lets you assign Policy Group(s) to a User Group.

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

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

URL

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

Available Since Version: 9.1

Parameters

Return Values

Examples

Example 1

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"UserGroupID":"1686621934417",
	"PolicyGroupIDList":["1686625081008"]
}

OUTPUT

{
	"Status":"OK"
}

Example 2

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"UserGroupID":"1686621934417",
	"PolicyGroupIDList":["1686626692901","1686626701490"]
}

OUTPUT

{
	"Status":"OK"
}

Example 3

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"UserGroupID":"1686621934417",
	"PolicyGroupIDList":["1686626692901"]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter PolicyGroupIDList, 1686626692901, already exists in UserGroupID 1686621934417!",
	"ExptType":"com.ahsay.cbs.mT"
}

Example 4

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"UserGroupID":"2",
	"Owner":"test",
	"PolicyGroupIDList":["1"]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter UserGroupID, 2 is not 13-digit format!",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}

Example 5

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"UserGroupID":"1111111111111",
	"Owner":"test",
	"PolicyGroupIDList":["2"]
}

OUTPUT

{
	"Status":"Error",
	"Message":"[Error] Parameter UserGroupID, 1111111111111 does not exist!",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}