Get Matter lock users

Use this action to list all the users configured on a Matter lock. A common use is to review who has access, for example before you add or remove a user.

For security, the lock never returns the actual credential secrets, such as PIN codes or RFID tag values. It only returns a reference to each credential.

This action returns its result in a response variable, which you can use in later steps of the same automation or script.

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 get lock users 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 query.
6. From the actions shown for that target, select Get Matter lock users.
7. Select Save.

Options in the UI

This action has no options.

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 matter.get_lock_users. Store the result in a response variable so you can use it in later steps:

action: matter.get_lock_users
target:
  entity_id: lock.front_door
response_variable: lock_users

Options in YAML

This action has no options.

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

• Entity: one specific matter entity, such as matter.living_room.
• Device: every matter entity that belongs to a device.
• Area: every matter entity in a room or area.
• Floor: every matter entity on a floor.
• Label: every matter 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 action returns the maximum number of users the lock supports and a list of the users that are configured. The response includes the following fields:

• max_users: The maximum number of users the lock can hold.
• users: A list of the configured users. Each user includes the following:
  • user_index: The user slot index.
  • user_name: The name of the user, if one is set.
  • user_status: Whether the user is active.
  • user_type: The type of user, such as unrestricted_user.
  • credential_rule: How many credentials the user must present to unlock.
  • credentials: A list of the user’s credentials, each with its type and slot index.
  • creator_fabric_index: The controller that created the user.
  • last_modified_fabric_index: The controller that last changed the user.

Good to know

• The creator_fabric_index and last_modified_fabric_index fields refer to the controller (such as Home Assistant, Apple Home, or Google Home) that created or changed the user.

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 a Matter lock user: Creates or updates a user on a Matter lock.

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

• Get Matter lock info: Returns the capabilities of a Matter lock.