Set lock user

Use this action to create or update a user on a Matter lock. A user is a person who can unlock the lock, and each user can have one or more credentials, such as a PIN code or an RFID tag.

If you leave the user index empty, the lock automatically assigns the next available slot.

Your lock must support the Matter Door Lock cluster user management features for this action to work. Use the Get lock info action to check what your lock supports.

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 set a lock 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 lock you want to manage.
6. From the actions shown for that target, under Matter, select Set lock user.
7. Fill in the user details you want to set.
8. Select Save.

Options in the UI

The available user types are:

• unrestricted_user: A regular user with no access restrictions.
• year_day_schedule_user: Access is limited to specific date ranges.
• week_day_schedule_user: Access is limited to specific days and times each week.
• programming_user: A user who can manage other users and credentials on the lock.
• non_access_user: A user record that exists on the lock but cannot unlock it.
• forced_user: A user whose access triggers a special alarm or notification, for example a duress code.
• disposable_user: A user whose credential is automatically revoked after a single use.
• expiring_user: A user whose access expires after a set period.
• schedule_restricted_user: A user restricted by both week-day and year-day schedules.
• remote_only_user: A user who can only operate the lock remotely, not from the physical keypad.

The available credential rules are:

• single: One credential is required to unlock, for example just a PIN.
• dual: Two different credentials are required to unlock, for example a PIN and an RFID tag.
• tri: Three different credentials are required to unlock.

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. For how an automation or a script is built in YAML, refer to Automations in YAML and Scripts.

In YAML, refer to this action as matter.set_lock_user. A basic example looks like this:

action: matter.set_lock_user
target:
  entity_id: lock.front_door
data:
  user_name: "Jane"
  user_type: unrestricted_user
  credential_rule: single

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 Matter lock behind that target.

• Entity: one specific Matter lock, such as lock.front_door.
• Device: every Matter lock that belongs to a device.
• Area: every Matter lock in a room or area.
• Floor: every Matter lock on a floor.
• Label: every Matter lock 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.

Good to know

• Creating a user does not give them a way to unlock the door yet. Add a credential, such as a PIN, with the Set lock credential action.

Still stuck?

To test the action on its own, run it in the automation editor with Run action, and check the message that it shows. To see what the action did when the automation ran, open the trace of that run. For details, refer to Testing automations. For common problems and their solutions, refer to Troubleshooting automations.

If that doesn’t help, 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

Explore related actions:

• Clear lock user: Deletes a user and their credentials from a Matter lock.

• Get lock users: Returns all users configured on a Matter lock.

• Set lock credential: Adds or updates a credential, such as a PIN, on a Matter lock.