AddPolicyGroupToUserGroup
July 21, 2025
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
Key | Type | Description |
---|---|---|
SysUser | String | Username of an AhsayCBS System User with Admin or API role. |
SysPwd | String | Password matching SysUser. |
UserGroupID | String | ID of user group. |
PolicyGroupIDList | Array of Strings | Array of Policy Group 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". |
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"
}