homeassistant.auth.providers.trusted_networks Namespace Reference

Classes
class	InvalidUserError
class	TrustedNetworksAuthProvider
class	TrustedNetworksLoginFlow

Variables
string	CONF_ALLOW_BYPASS_LOGIN = "allow_bypass_login"
string	CONF_GROUP = "group"
string	CONF_TRUSTED_NETWORKS = "trusted_networks"
string	CONF_TRUSTED_USERS = "trusted_users"
	CONFIG_SCHEMA
	IPAddress
	IPNetwork

Detailed Description

Trusted Networks auth provider.

It shows list of users if access from trusted network.
Abort login flow if not access from trusted network.

Variable Documentation

CONF_ALLOW_BYPASS_LOGIN

string homeassistant.auth.providers.trusted_networks.CONF_ALLOW_BYPASS_LOGIN = "allow_bypass_login"

Definition at line 43 of file trusted_networks.py.

CONF_GROUP

string homeassistant.auth.providers.trusted_networks.CONF_GROUP = "group"

Definition at line 42 of file trusted_networks.py.

CONF_TRUSTED_NETWORKS

string homeassistant.auth.providers.trusted_networks.CONF_TRUSTED_NETWORKS = "trusted_networks"

Definition at line 40 of file trusted_networks.py.

CONF_TRUSTED_USERS

string homeassistant.auth.providers.trusted_networks.CONF_TRUSTED_USERS = "trusted_users"

Definition at line 41 of file trusted_networks.py.

CONFIG_SCHEMA

homeassistant.auth.providers.trusted_networks.CONFIG_SCHEMA

Initial value:

=  AUTH_PROVIDER_SCHEMA.extend(
    {
        vol.Required(CONF_TRUSTED_NETWORKS): vol.All(cv.ensure_list, [ip_network]),
        vol.Optional(CONF_TRUSTED_USERS, default={}): vol.Schema(
            # we only validate the format of user_id or group_id
            {
                ip_network: vol.All(
                    cv.ensure_list,
                    [
                        vol.Or(
                            cv.uuid4_hex,
                            vol.Schema({vol.Required(CONF_GROUP): str}),
                        )
                    ],
                )
            }
        ),
        vol.Optional(CONF_ALLOW_BYPASS_LOGIN, default=False): cv.boolean,
    },
    extra=vol.PREVENT_EXTRA,
)

Definition at line 45 of file trusted_networks.py.

IPAddress

homeassistant.auth.providers.trusted_networks.IPAddress

Definition at line 37 of file trusted_networks.py.

IPNetwork

homeassistant.auth.providers.trusted_networks.IPNetwork

Definition at line 38 of file trusted_networks.py.