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

# ConfigUserGroup

> Sample shape for ConfigUserGroup.

Sample shape for `ConfigUserGroup`.

## Sample JSON

Copy, edit, paste. Server-set fields (`id`, `created`, `tenantId`, …) are omitted from the example — they're populated by the server on response.

```json theme={null}
{
  "name": "Example name",
  "description": "Example description.",
  "type": "<group-type>",
  "member": [
    "example"
  ]
}
```

## Fields

| Field         | Type                                            | Required     | Notes                                   |
| ------------- | ----------------------------------------------- | ------------ | --------------------------------------- |
| `entity`      | string • nullable                               | Server-set   | Set by the server. Read-only on writes. |
| `name`        | string                                          | **Required** |                                         |
| `description` | string                                          | Optional     |                                         |
| `type`        | [`GroupType`](/data-model/constants#group-type) | Optional     |                                         |
| `member`      | array\<string>                                  | Optional     |                                         |
| `tenantId`    | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `id`          | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `created`     | string (date-time)                              | Server-set   | Set by the server. Read-only on writes. |
| `createdBy`   | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `updated`     | string (date-time)                              | Server-set   | Set by the server. Read-only on writes. |
| `updatedBy`   | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `deleted`     | boolean                                         | Server-set   | Set by the server. Read-only on writes. |

## Used by

### Request body

* `POST /api/security/user-group`
* `PUT /api/security/user-group`

### Response body

* `GET /api/security/user-group/{id}`
* `GET /api/security/user-group`

### CLI

`ekso user-group` — see the [command branches](/cli/branches) page for available verbs. Body for create / update verbs typically passed via `--data @file.json` matching the [sample JSON](#sample-json) above.