Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.config.auth_provider_homeassistant Namespace Reference

Functions

bool async_setup (HomeAssistant hass)
 
None websocket_admin_change_password (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_admin_change_username (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_change_password (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_create (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None websocket_delete (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 

Detailed Description

Offer API to configure the Home Assistant auth provider.

Function Documentation

◆ async_setup()

bool homeassistant.components.config.auth_provider_homeassistant.async_setup ( HomeAssistant  hass)
Enable the Home Assistant views.

Definition at line 16 of file auth_provider_homeassistant.py.

◆ websocket_admin_change_password()

None homeassistant.components.config.auth_provider_homeassistant.websocket_admin_change_password ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Change password of any user.

Definition at line 153 of file auth_provider_homeassistant.py.

◆ websocket_admin_change_username()

None homeassistant.components.config.auth_provider_homeassistant.websocket_admin_change_username ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Change the username for any user.

Definition at line 195 of file auth_provider_homeassistant.py.

◆ websocket_change_password()

None homeassistant.components.config.auth_provider_homeassistant.websocket_change_password ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Change current user password.

Definition at line 106 of file auth_provider_homeassistant.py.

◆ websocket_create()

None homeassistant.components.config.auth_provider_homeassistant.websocket_create ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Create credentials and attach to a user.

Definition at line 36 of file auth_provider_homeassistant.py.

◆ websocket_delete()

None homeassistant.components.config.auth_provider_homeassistant.websocket_delete ( HomeAssistant  hass,
websocket_api.ActiveConnection  connection,
dict[str, Any]  msg 
)
Delete username and related credential.

Definition at line 74 of file auth_provider_homeassistant.py.