Set user

Use this action to create or update an access-control user on a Z-Wave lock. A user is the person a credential belongs to. After creating a user, add a PIN code or password with the Set credential action.

This action supersedes the older Set lock user code action and works across a variety of legacy and modern Z-Wave locks. It lets you store multiple credentials per user, assign user types, and require multiple credentials to unlock.

If you omit the user index, the integration assigns the first available slot. The action returns the assigned user index in a response variable.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To create or update a user from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the locks to create or update the user on.
6. From the actions shown for that target, select Set user.
7. Set the options you want to use.
8. In the Response variable field, enter a name to store the result, for example, result.
9. Select Save.

Options in the UI

The available user types are:

• general: Can operate the lock.
• programming: Can program the device, manage users, and operate the lock.
• non_access: Is recognized, but cannot open the lock (only sends events).
• duress: Can open the lock, but sends an alarm to the hub.
• disposable: Can open the lock once, then is disabled.
• expiring: Can operate the lock. Access is disabled after a set time once first used.
• remote_only: Can only operate the lock remotely.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as zwave_js.set_user. Store the result in a response variable so you can use the assigned user index in later steps:

action: zwave_js.set_user
target:
  entity_id: lock.front_door
data:
  user_name: "Jane"
  user_type: general
  credential_rule: single
response_variable: result

Options in YAML

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching lock entity behind that target.

• Entity: one specific lock entity, such as lock.living_room.
• Device: every lock entity that belongs to a device.
• Area: every lock entity in a room or area.
• Floor: every lock entity on a floor.
• Label: every lock entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Response data

The response is keyed by lock entity. Each entry includes the assigned user index:

lock.front_door:
  user_id: 1

Good to know

• A user is a person; a credential is a PIN code or password. Create the user first, then add a credential.
• The maximum user name length and the supported user types and credential rules vary by lock. Check them with the Get credential capabilities action.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Set credential: Adds or updates a PIN code or password for an existing user on a Z-Wave lock.

• Delete user: Deletes an access-control user and all their credentials from a Z-Wave lock.

• Get users: Lists all access-control users and their credential references on a Z-Wave lock.