AddUserGroup

July 21, 2025

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

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin, API or Read-Only API role.
SysPwd String Password matching SysUser.
UserGroupName String Name of the user group.
Type String The value can be any one of the following: backup-user (Default value).
UserIdList String Multiple login names, separated by commas, are accepted. For example; user1, user2, user3.
PolicyIDList Array of String Array of policy ID.
Return Values
Key Type Description
Status String "OK" or "Error"
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".
ID String ID of User Group.
JSON Objects

EditBillingContactBean

Key Type Description
ContactId String ID of contact.
Name String Name of contact.
Email String Email of contact.
Address String Address of contact.
Company String Company of contact.
Website String Website of contact.
Phone1 String Telephone number of contact.
Phone2 String Alternate telephone number of contact.
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"
}
Documentation