> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IWorkspaceUserGroup

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/userGroup/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

User Group

**Signature:**

```typescript
export interface IWorkspaceUserGroup 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceusergroup/index.md#iworkspaceusergroupdescription) |  | string | **_(ALPHA)_** _(Optional)_ Group description |
| [id?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceusergroup/index.md#iworkspaceusergroupid) |  | string | **_(ALPHA)_** _(Optional)_ Stored user group id |
| [name?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceusergroup/index.md#iworkspaceusergroupname) |  | string | **_(ALPHA)_** _(Optional)_ Group name |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspaceusergroup/index.md#iworkspaceusergroupref) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(ALPHA)_** Stored user group reference |

## Property details

### IWorkspaceUserGroup.description

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Group description

**Signature:**

```typescript
description?: string;
```

### IWorkspaceUserGroup.id

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Stored user group id

**Signature:**

```typescript
id?: string;
```

### IWorkspaceUserGroup.name

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Group name

**Signature:**

```typescript
name?: string;
```

### IWorkspaceUserGroup.ref

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Stored user group reference

**Signature:**

```typescript
ref: ObjRef;
```
