ListUserGroups

July 21, 2025

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

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
UserGroupID String Returns information of the user group with this ID. If UserGroupID and UserID are not provided, information of all user groups will be returned.
UserID String Returns information of the user groups that contain the user. If UserGroupID and UserID are not provided, information of all user groups will be returned.
UserGroupOnly Boolean Default value is false.
Return Values
Key Type Description
Status String "OK" or "Error"
Data UserGroupBasicInfo or UserGroupFullInfo If UserGroupOnly is true, UserGroupBasicInfo is returned. Otherwise, UserGroupFillInfo is returned.
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".
JSON Objects

UserGroupBasicInfo

Key Type Description
ID String ID of the user group.
Name UserGroupBasicInfor or UserGroupFullInfo Name of the user group.
Type String Value is BACKUP_USER.
Owner String Owner of the user group.

UserGroupFullInfo

Key Type Description
ID String ID of the user group
Name UserGroupBasicInfor or UserGroupFullInfo Name of the user group.
Type String Value is BACKUP_USER.
Owner String Owner of the user group.
Users Array of User Array list of users assigned to the user group.
PolicyGroup Array of Policy Array list of assigned policy group to the user group.

User

Key Type Description
LoginName String Backup user name.
Owner String Owner of the user.
UserId String ID of the user.

Policy

Key Type Description
ID String ID of the policy.
Name String Name of the policy.
Example

INPUT

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

OUTPUT

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