Get credential capabilities

Use this action to find out what a Z-Wave lock supports for user and credential management, such as the maximum number of users, the supported user types and credential rules, and the slot count and length range for each credential type. Run this before calling the other user and credential actions so you know what your specific lock allows.

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 the credential capabilities 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 query.
6. From the actions shown for that target, select Get credential capabilities.
7. In the Response variable field, enter a name to store the result, for example, capabilities.
8. 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 zwave_js.get_credential_capabilities. Store the result in a response variable so you can use it in later steps:

action: zwave_js.get_credential_capabilities
target:
  entity_id: lock.front_door
response_variable: capabilities

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 reports the user and credential limits of the lock. A shortened example looks like this:

lock.front_door:
  supports_user_management: true
  max_users: 20
  supported_user_types:
    - general
    - programming
  max_user_name_length: 16
  supported_credential_rules:
    - single
    - dual
  supported_credential_types:
    pin_code:
      num_slots: 20
      min_length: 4
      max_length: 10
      supports_learn: false
    password:
      num_slots: 20
      min_length: 4
      max_length: 16
      supports_learn: false

Good to know

• Use the reported limits to choose valid user indexes, credential slots, and credential lengths before calling the other actions.

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:

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

• Set user: Creates or updates an access-control user on a Z-Wave lock.

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