User Group

​

get_user_group_list

Get all user groups for this tenant.

​

Parameters

None.

​

Returns

A list of UserGroupDto objects, each containing:

• userGroupId — unique group identifier
• name — group name
• description — group description
• type — group type (e.g. Custom, System)
• memberCount — number of members in the group

---

​

create_user_group

Create a new custom user group.

​

Parameters

​

Returns

The created UserGroupDto. Requires super admin.

---

​

update_user_group

Update an existing user group. Only provided fields are updated.

​

Parameters

​

Returns

The updated UserGroupDto. Requires super admin.

---

​

delete_user_group

Delete a custom user group. Only custom groups can be deleted.

​

Parameters

​

Returns

A confirmation message. Requires super admin.