Skip to content
CapaSystems Docs

Create Local User

Creates a local user account, or updates the password if the user already exists. Optionally ensures the user is added to one or more local groups.

Parameters

Section titled “Parameters”

Username

Section titled “Username”

Required

Specifies the local username.

Full Name

Section titled “Full Name”

Optional

Specifies the full name for the local user. If empty, the username is used.

Password

Section titled “Password”

Required

Specifies the password for the local user.

Description

Section titled “Description”

Optional

Specifies an optional local user description.

Password Never Expires

Section titled “Password Never Expires”

Required — Default: True

Enable to set the local account password to never expire. Disable to use normal password expiration.

User Cannot Change Password

Section titled “User Cannot Change Password”

Required — Default: False

Enable to prevent this account from changing its own password. Disable to allow password changes by the account.

Groups

Section titled “Groups”

Optional

Optional group names or SIDs to add the user to. Separate multiple values with comma, semicolon, or newline. Examples: Administrators, S-1-5-32-544, Remote Desktop Users, DOMAIN\GroupName

Details

Section titled “Details”
  • Category: User management
  • Brick ID: UsrMgr-CreateLocalUser

Raw JSON definition

Section titled “Raw JSON definition”
{
  "category": "userManagement",
  "description": "Creates a local user account, or updates the password if the user already exists. Optionally ensures the user is added to one or more local groups.",
  "developerVendor": "CapaSystems A/S",
  "displayName": null,
  "id": "UsrMgr-CreateLocalUser",
  "name": "Create Local User",
  "parameters": [
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Specifies the local username.",
      "id": "Username",
      "name": "Username",
      "regExValidation": "",
      "required": true,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Specifies the full name for the local user. If empty, the username is used.",
      "id": "FullName",
      "name": "Full Name",
      "regExValidation": "",
      "required": false,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Specifies the password for the local user.",
      "id": "Password",
      "name": "Password",
      "regExValidation": "",
      "required": true,
      "type": "TextBoxWithPassword",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Specifies an optional local user description.",
      "id": "Description",
      "name": "Description",
      "regExValidation": "",
      "required": false,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "True",
      "defaultValueObject": null,
      "description": "Enable to set the local account password to never expire. Disable to use normal password expiration.",
      "id": "PasswordNeverExpire",
      "name": "Password Never Expires",
      "regExValidation": "",
      "required": true,
      "type": "Boolean",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "False",
      "defaultValueObject": null,
      "description": "Enable to prevent this account from changing its own password. Disable to allow password changes by the account.",
      "id": "UserCannotChangePwd",
      "name": "User Cannot Change Password",
      "regExValidation": "",
      "required": true,
      "type": "Boolean",
      "value": null,
      "values": [],
      "valuesObject": null
    },
    {
      "defaultValue": "",
      "defaultValueObject": null,
      "description": "Optional group names or SIDs to add the user to. Separate multiple values with comma, semicolon, or newline.\nExamples: Administrators, S-1-5-32-544, Remote Desktop Users, DOMAIN\\GroupName",
      "id": "Groups",
      "name": "Groups",
      "regExValidation": "",
      "required": false,
      "type": "TextBox",
      "value": null,
      "values": [],
      "valuesObject": null
    }
  ],
  "powershell": {
    "base64Encoded": true,
    "function": "ZnVuY3Rpb2..."
  },
  "type": "powerbrick",
  "version": "2026.7.2.1"
}