homeassistant.auth Namespace Reference

Namespaces
	auth_store
	const
	jwt_wrapper
	mfa_modules
	models
	permissions
	providers

Classes
class	AuthManager
class	AuthManagerFlowManager
class	InvalidAuthError
class	InvalidProvider

Functions
AuthManager	auth_manager_from_config (HomeAssistant hass, list[dict[str, Any]] provider_configs, list[dict[str, Any]] module_configs)

Variables
	_MfaModuleDict
	_ProviderDict
	_ProviderKey
string	EVENT_USER_ADDED = "user_added"
string	EVENT_USER_REMOVED = "user_removed"
string	EVENT_USER_UPDATED = "user_updated"

Detailed Description

Provide an authentication layer for Home Assistant.

Function Documentation

auth_manager_from_config()

AuthManager homeassistant.auth.auth_manager_from_config	(	HomeAssistant	hass,
		list[dict[str, Any]]	provider_configs,
		list[dict[str, Any]]	module_configs
	)

Initialize an auth manager from config.

CORE_CONFIG_SCHEMA will make sure no duplicated auth providers or
mfa modules exist in configs.

Definition at line 50 of file __init__.py.

Variable Documentation

_MfaModuleDict

homeassistant.auth._MfaModuleDict

private

Definition at line 37 of file __init__.py.

_ProviderDict

homeassistant.auth._ProviderDict

private

Definition at line 39 of file __init__.py.

_ProviderKey

homeassistant.auth._ProviderKey

private

Definition at line 38 of file __init__.py.

EVENT_USER_ADDED

string homeassistant.auth.EVENT_USER_ADDED = "user_added"

Definition at line 33 of file __init__.py.

EVENT_USER_REMOVED

string homeassistant.auth.EVENT_USER_REMOVED = "user_removed"

Definition at line 35 of file __init__.py.

EVENT_USER_UPDATED

string homeassistant.auth.EVENT_USER_UPDATED = "user_updated"

Definition at line 34 of file __init__.py.