Home Assistant Unofficial Reference 2024.12.1
homeassistant.scripts.auth Namespace Reference

Functions

None add_user (HomeAssistant hass, hass_auth.HassAuthProvider provider, argparse.Namespace args)
 
None change_password (HomeAssistant hass, hass_auth.HassAuthProvider provider, argparse.Namespace args)
 
None list_users (HomeAssistant hass, hass_auth.HassAuthProvider provider, argparse.Namespace args)
 
None run (Sequence[str]|None args)
 
None run_command (argparse.Namespace args)
 
None validate_login (HomeAssistant hass, hass_auth.HassAuthProvider provider, argparse.Namespace args)
 

Detailed Description

Script to manage users for the Home Assistant auth provider.

Function Documentation

◆ add_user()

None homeassistant.scripts.auth.add_user ( HomeAssistant  hass,
hass_auth.HassAuthProvider  provider,
argparse.Namespace   args 
)
Create a user.

Definition at line 85 of file auth.py.

◆ change_password()

None homeassistant.scripts.auth.change_password ( HomeAssistant  hass,
hass_auth.HassAuthProvider  provider,
argparse.Namespace   args 
)
Change password.

Definition at line 115 of file auth.py.

◆ list_users()

None homeassistant.scripts.auth.list_users ( HomeAssistant  hass,
hass_auth.HassAuthProvider  provider,
argparse.Namespace   args 
)
List the users.

Definition at line 70 of file auth.py.

◆ run()

None homeassistant.scripts.auth.run ( Sequence[str] | None  args)
Handle Home Assistant auth provider script.

Definition at line 20 of file auth.py.

◆ run_command()

None homeassistant.scripts.auth.run_command ( argparse.Namespace  args)
Run the command.

Definition at line 55 of file auth.py.

◆ validate_login()

None homeassistant.scripts.auth.validate_login ( HomeAssistant  hass,
hass_auth.HassAuthProvider  provider,
argparse.Namespace   args 
)
Validate a login.

Definition at line 102 of file auth.py.