get_user_group_list
Get all user groups for this tenant.| Property | |
|---|---|
| Read-only | Yes |
Parameters
None.Returns
A list ofUserGroupDto objects, each containing:
userGroupId— unique group identifiername— group namedescription— group descriptiontype— group type (e.g. Custom, System)memberCount— number of members in the group
create_user_group
Create a new custom user group.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Group name. |
description | string | No | Group description. |
Returns
The createdUserGroupDto. Requires super admin.
update_user_group
Update an existing user group. Only provided fields are updated.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
userGroupId | string | Yes | The group ID. Use get_user_group_list. |
name | string | No | New group name. |
description | string | No | New group description. |
Returns
The updatedUserGroupDto. Requires super admin.
delete_user_group
Delete a custom user group. Only custom groups can be deleted.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
userGroupId | string | Yes | The group ID. Use get_user_group_list. |