homeassistant.auth.mfa_modules Namespace Reference

Namespaces
	insecure_example
	notify
	totp

Classes
class	MultiFactorAuthModule
class	SetupFlow

Functions
types.ModuleType	_load_mfa_module (HomeAssistant hass, str module_name)
MultiFactorAuthModule	auth_mfa_module_from_config (HomeAssistant hass, dict[str, Any] config)

Variables
	_LOGGER = logging.getLogger(__name__)
	MULTI_FACTOR_AUTH_MODULE_SCHEMA

Detailed Description

Pluggable auth modules for Home Assistant.

Function Documentation

_load_mfa_module()

types.ModuleType homeassistant.auth.mfa_modules._load_mfa_module ( HomeAssistant  hass, str  module_name  )

private

Load an mfa auth module.

Definition at line 148 of file __init__.py.

auth_mfa_module_from_config()

MultiFactorAuthModule homeassistant.auth.mfa_modules.auth_mfa_module_from_config	(	HomeAssistant	hass,
		dict[str, Any]	config
	)

Initialize an auth module from a config.

Definition at line 128 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.auth.mfa_modules._LOGGER = logging.getLogger(__name__)

private

Definition at line 35 of file __init__.py.

MULTI_FACTOR_AUTH_MODULE_SCHEMA

homeassistant.auth.mfa_modules.MULTI_FACTOR_AUTH_MODULE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_TYPE): str,
        vol.Optional(CONF_NAME): str,
        # Specify ID if you have two mfa auth module for same type.
        vol.Optional(CONF_ID): str,
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 23 of file __init__.py.