AddUser (v1,v2)

This API can be used to add new backup user.

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

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

v1 AddUser.do

URL

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

Deprecated Since Version: 7.15.6.38

v2 AddUser.do

URL

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

Available Since Version: 9.5

Parameters

QuotaList

Return Values

Examples

Example 1: Add AhsayOBM paid user with AhsayCBS quota 50 GB and predefined destination quota of 50 GB

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2",
	"Password":"obm2",
	"Email":"obm2@example.com",
	"Type":"Paid",
	"Status":"ENABLE",
	"ClientType":"OBM",
	"QuotaList":[
		{
			"Enabled":true,
			"DestinationKey":"-1686812937526",
			"Quota":53687091200
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

OUTPUT 2: If destination is not visible to user

{
	"Status":"Error",
	"Message":"Destination ‘-1686812937526’ is not visible to user ‘obm2’ according to policy’s [Destinations Visible to Users] settings.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 3: If the Enable parameter is missing from a destination in the QuotaList

{
	"Status":"Error",
	"Message":"Value ‘Enabled’ is missing in item ‘-1686812937526’ of ‘QuotaList’.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 4: If Enable is invalid for a destination in the QuotaList

{
	"Status":"Error",
	"Message":"Invalid ‘Enabled’ in item ‘-1686812937526’ of ‘QuotaList’.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 5: If a destination is duplicated in the QuotaList

{
	"Status":"Error",
	"Message":"Duplicated DestinationKey (-1686812937526) are not allowed in the QuotaList.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 6: If the Quota value for a destination is invalid (e.g. a negative number)

{
	"Status":"Error",
	"Message":"Invalid value for ‘Quota’ for item ‘-1686812937526’ of ‘QuotaList’. Error: Must be a positive number.",
	"ExptType":"java.lang.Exception"
}

OUTPUT 7: If the Quota value for a destination is invalid

{
	"Status":"Error",
	"Message":"Invalid value ‘Quota’ for item ‘-1686812937526’ of ‘QuotaList’. Error: JSONObject [\”Quota\”] is not a long (class java.lang.String: ac130).",
	"ExptType":"java.lang.Exception"
}

Example 2: Add AhsayOBM paid user with AhsayCBS quota 50 GB and Total Quota 75 GB

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm1",
	"Password":"obm1",
	"Email":"testobm@example.com",
	"Type":"Paid",
	"Status":"ENABLE",
	"ClientType":"OBM",
	"QuotaType":"TOTAL_QUOTA",
	"StorageQuota":75,
	"QuotaList":[
		{
			"DestinationKey":"OBS",
			"Quota":53687091200,
			"DestinationName":"AhsayCBS",
			"Enabled":true
		}
	]
}

OUTPUT

{
	"Status":"OK"
}

Example 3: Invalid Quota value specified

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm2",
	"Password":"obm2",
	"Email":"obm2@example.com",
	"Type":"Paid",
	"Status":"ENABLE",
	"ClientType":"OBM",
	"QuotaList":[
		{
			"Enabled":true,
			"DestinationKey":"OBS",
			"Quota":53687091200
		}
	]
}

OUTPUT

{
	"Status":"OK"
}