User management - Spook 👻 a scary powerful toolbox for Home Assistant.

A user in Home Assistant is an account that can log in and control your home. Spook provides you with actions to enable and disable user accounts on the fly.

Actions¶

The following user management actions are added to your Home Assistant instance:

Disable a user¶

This action allows you to disable a user account on the fly, preventing them from logging in.

Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action properties
Action	Disable a user 👻
Action name	`homeassistant.disable_user`
Action targets	No
Action response	No response
Spook's influence	Newly added action.
Developer tools	Try this action

Action data parameters
Attribute	Type	Required	Default / Example
`user_id`	string \| list of strings	Yes	`bf1f3b59c7a842c8a9de3e1c12345678`

Finding a user ID

Not sure what the user_id of a user is? You can find it in the Home Assistant UI by going to Settings → People → selecting the person → clicking on the User tab. The user ID is displayed on that page.

Alternatively, you can use the Developer Tools → Template tab and use the following template to list all user IDs:

{% for state in states.person %}
Name: {{ state.name }}
ID: {{ state.attributes.user_id }}
------------------
{% endfor %}

Example action in YAML

1
2
3
action: homeassistant.disable_user
data:
  user_id: "bf1f3b59c7a842c8a9de3e1c12345678"

Or multiple users at once:

1
2
3
4
5
action: homeassistant.disable_user
data:
  user_id:
    - "bf1f3b59c7a842c8a9de3e1c12345678"
    - "a3c9d12e4f5b678901234567890abcde"

Enable a user¶

This action allows you to enable a user account on the fly, allowing them to log in again.

Action properties
Action	Enable a user 👻
Action name	`homeassistant.enable_user`
Action targets	No
Action response	No response
Spook's influence	Newly added action.
Developer tools	Try this action

Action data parameters
Attribute	Type	Required	Default / Example
`user_id`	string \| list of strings	Yes	`bf1f3b59c7a842c8a9de3e1c12345678`

Finding a user ID

Example action in YAML

1
2
3
action: homeassistant.enable_user
data:
  user_id: "bf1f3b59c7a842c8a9de3e1c12345678"

Or multiple users at once:

1
2
3
4
5
action: homeassistant.enable_user
data:
  user_id:
    - "bf1f3b59c7a842c8a9de3e1c12345678"
    - "a3c9d12e4f5b678901234567890abcde"

Blueprints & tutorials¶

There are currently no known blueprints or tutorials for the enhancements Spook provides for these features. If you created one or stumbled upon one, please let us know in our discussion forums.

Features requests, ideas, and support¶

If you have an idea on how to further enhance this, for example, by adding a new action, entity, or repairs detection; feel free to let us know in our discussion forums.

Are you stuck using these new features? Or maybe you’ve run into a bug? Please check the page on where to go for help.