# $cs.UsrMgr_AddUserToLocalGroup

> Adds a local user account to a local group. The groupName parameter accepts either a plain group name (e.g. Administrators) or a group SID.

Source: https://docs.capaone.com/capainstaller/powerpacks/cs-usrmgr-addusertolocalgroup/  
Product: CapaInstaller — a separate CapaSystems product; do not apply this page to any other.

### Description

Adds a local user account to a local group. The `groupName` parameter accepts either a plain group name (e.g. `Administrators`) or a group SID. Throws an exception if the operation fails.

### Syntax

$cs.UsrMgr_AddUserToLocalGroup(string userName, string groupName)

### Parameters

#### userName (String)

The local user account to add to the group.

#### groupName (String)

The group to add the user to. Can be a plain group name or a SID (a value containing `S-1-5-` is treated as a SID).

### Return value

None.

### Example

**PowerShell**

Add a service account to the local `Administrators` group by name during install:

```powershell
if ($cs.UsrMgr_ExistLocalUserAccount('capaadmin')) {
  $cs.Job_WriteLog("Adding capaadmin to Administrators group")
  $cs.UsrMgr_AddUserToLocalGroup('capaadmin', 'Administrators')
}
```

Use the well-known SID `S-1-5-32-544` instead of the localized group name, so the same script works on non-English builds of Windows:

```powershell
if ($cs.UsrMgr_ExistLocalUserAccount('svc_capaagent')) {
  $cs.Job_WriteLog("Adding svc_capaagent to the local Administrators group (locale-independent)")
  $cs.UsrMgr_AddUserToLocalGroup('svc_capaagent', 'S-1-5-32-544')
}
```

Grant a support account access to a custom, application-specific local group:

```powershell
if ($cs.UsrMgr_ExistLocalUserAccount('capasupport')) {
  $cs.Job_WriteLog("Adding capasupport to AppRemoteUsers")
  $cs.UsrMgr_AddUserToLocalGroup('capasupport', 'AppRemoteUsers')
}
```

### Related functions

[$cs.UsrMgr_RemoveUserFromLocalGroup](/capainstaller/powerpacks/cs-usrmgr-removeuserfromlocalgroup/) [$cs.UsrMgr_EnumMembersOfLocalGroup](/capainstaller/powerpacks/cs-usrmgr-enummembersoflocalgroup/)