homeassistant.auth.providers Namespace Reference

Namespaces
	command_line
	homeassistant
	insecure_example
	trusted_networks

Classes
class	AuthProvider
class	LoginFlow

Functions
AuthProvider	auth_provider_from_config (HomeAssistant hass, AuthStore store, dict[str, Any] config)
types.ModuleType	load_auth_provider_module (HomeAssistant hass, str provider)

Variables
	_LOGGER = logging.getLogger(__name__)
	AUTH_PROVIDER_SCHEMA

Detailed Description

Auth providers for Home Assistant.

Function Documentation

auth_provider_from_config()

AuthProvider homeassistant.auth.providers.auth_provider_from_config	(	HomeAssistant	hass,
		AuthStore	store,
		dict[str, Any]	config
	)

Initialize an auth provider from a config.

Definition at line 144 of file __init__.py.

load_auth_provider_module()

types.ModuleType homeassistant.auth.providers.load_auth_provider_module	(	HomeAssistant	hass,
		str	provider
	)

Load an auth provider.

Definition at line 164 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 34 of file __init__.py.

AUTH_PROVIDER_SCHEMA

homeassistant.auth.providers.AUTH_PROVIDER_SCHEMA

Initial value:

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

Definition at line 39 of file __init__.py.