Clear lock user

Use this action to delete a user and all their credentials from a Matter lock. A common use is to remove access for someone who no longer needs it, for example a former houseguest.

To remove every user at once, use index 65534. This is a special value defined by the Matter specification (hex 0xFFFE) that tells the lock to remove all users.

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 clear 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 Clear lock user.
7. Enter the User index to remove.
8. Select Save.

Options in the UI

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.clear_lock_user. A basic example looks like this:

action: matter.clear_lock_user
target:
  entity_id: lock.front_door
data:
  user_index: 3

To remove every user at once, use index 65534:

action: matter.clear_lock_user
target:
  entity_id: lock.front_door
data:
  user_index: 65534

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

• Clearing a user also removes all credentials linked to that user, such as their PIN codes and RFID tags.
• Clearing all users with index 65534 cannot be undone. The lock keeps no record of the users it removed.

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:

• Set lock user: Creates or updates a user on a Matter lock.

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

• Clear lock credential: Removes a credential, such as a PIN, from a Matter lock.