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

# NSUserGroup

> The main user group that this user belongs to.

The main user group that this user belongs to.

## Constructors

### NSUserGroup()

```crmscript theme={null}
NSUserGroup
```

Initializes a new instance of the NSUserGroup class.

## Methods

## GetDeleted()

```crmscript theme={null}
Bool GetDeleted()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - true means that this is a user group that no longer can be selected by the user.

<Note>
  It is not permitted to delete a UserGroup.
</Note>

**Example:**

```crmscript theme={null}
NSUserGroup thing;
Bool deleted = thing.GetDeleted();
```

## GetId()

```crmscript theme={null}
Integer GetId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key.

**Example:**

```crmscript theme={null}
NSUserGroup thing;
Integer id = thing.GetId();
```

## GetRank()

```crmscript theme={null}
Integer GetRank()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Rank order.

**Example:**

```crmscript theme={null}
NSUserGroup thing;
Integer rank = thing.GetRank();
```

## GetTooltip()

```crmscript theme={null}
String GetTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Tooltip or other description.

**Example:**

```crmscript theme={null}
NSUserGroup thing;
String tooltip = thing.GetTooltip();
```

## GetValue()

```crmscript theme={null}
String GetValue()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - UserGroup name.

**Example:**

```crmscript theme={null}
NSUserGroup thing;
String value = thing.GetValue();
```

## SetDeleted(Bool)

Marks a user group.

```crmscript theme={null}
Void SetDeleted(Bool deleted)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  It is not permitted to delete a UserGroup.
</Note>

**Example:**

```crmscript theme={null}
NSUserGroup thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetId(Integer)

```crmscript theme={null}
Void SetId(Integer id)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSUserGroup thing;
Integer id;
thing.SetId(id);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSUserGroup thing;
Integer rank;
thing.SetRank(rank);
```

## SetTooltip(String)

```crmscript theme={null}
Void SetTooltip(String tooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSUserGroup thing;
String tooltip;
thing.SetTooltip(tooltip);
```

## SetValue(String)

```crmscript theme={null}
Void SetValue(String value)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSUserGroup thing;
String value;
thing.SetValue(value);
```


## Related topics

- [NSUserAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSUserAgent.md)
- [NSUser](/en/automation/crmscript/reference/CRMScript.NetServer.NSUser.md)
- [Users](/en/admin/user-management/index.md)
- [User group filtering](/en/admin/lists/user-group-filtering.md)
- [Manage user groups](/en/admin/user-management/user-groups.md)
- [Delete User Group](/en/api/reference/restful/agent/user_agent/delete-user-group.md)