homeassistant.components.config.auth Namespace Reference

Functions
dict[str, Any]	_user_info (User user)
bool	async_setup (HomeAssistant hass)
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)
None	websocket_list (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_update (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	SCHEMA_WS_DELETE
	SCHEMA_WS_LIST
string	WS_TYPE_DELETE = "config/auth/delete"
string	WS_TYPE_LIST = "config/auth/list"

Detailed Description

Offer API to configure Home Assistant auth.

Function Documentation

_user_info()

dict[str, Any] homeassistant.components.config.auth._user_info ( User  user )

private

Format a user.

Definition at line 159 of file auth.py.

async_setup()

bool homeassistant.components.config.auth.async_setup

(

HomeAssistant

hass

)

Enable the Home Assistant views.

Definition at line 25 of file auth.py.

websocket_create()

None homeassistant.components.config.auth.websocket_create	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Create a user.

Definition at line 88 of file auth.py.

websocket_delete()

None homeassistant.components.config.auth.websocket_delete	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Delete a user.

Definition at line 53 of file auth.py.

websocket_list()

None homeassistant.components.config.auth.websocket_list	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Return a list of users.

Definition at line 40 of file auth.py.

websocket_update()

None homeassistant.components.config.auth.websocket_update	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Update a user.

Definition at line 115 of file auth.py.

Variable Documentation

SCHEMA_WS_DELETE

homeassistant.components.config.auth.SCHEMA_WS_DELETE

Initial value:

=  websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
    {vol.Required("type"): WS_TYPE_DELETE, vol.Required("user_id"): str}
)

Definition at line 19 of file auth.py.

SCHEMA_WS_LIST

homeassistant.components.config.auth.SCHEMA_WS_LIST

Initial value:

=  websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
    {vol.Required("type"): WS_TYPE_LIST}
)

Definition at line 14 of file auth.py.

WS_TYPE_DELETE

string homeassistant.components.config.auth.WS_TYPE_DELETE = "config/auth/delete"

Definition at line 18 of file auth.py.

WS_TYPE_LIST

string homeassistant.components.config.auth.WS_TYPE_LIST = "config/auth/list"

Definition at line 13 of file auth.py.