> ## Documentation Index
> Fetch the complete documentation index at: https://ekso.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# User Group

> MCP tools for managing user groups.

## get\_user\_group\_list

Get all user groups for this tenant.

| Property      |     |
| ------------- | --- |
| **Read-only** | Yes |

### 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.

| Property      |    |
| ------------- | -- |
| **Read-only** | No |

### Parameters

| Parameter     | Type   | Required | Description        |
| ------------- | ------ | -------- | ------------------ |
| `name`        | string | Yes      | Group name.        |
| `description` | string | No       | Group description. |

### Returns

The created `UserGroupDto`. 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`](#get_user_group_list). |
| `name`        | string | No       | New group name.                                                  |
| `description` | string | No       | New group description.                                           |

### Returns

The updated `UserGroupDto`. 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`](#get_user_group_list). |

### Returns

A confirmation message. Requires super admin.