homeassistant.components.auth.mfa_setup_flow Namespace Reference

Classes
class	MfaFlowManager

Functions
data_entry_flow.FlowResult	_prepare_result_json (data_entry_flow.FlowResult result)
None	async_setup (HomeAssistant hass)
None	websocket_depose_mfa (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_setup_mfa (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	_LOGGER = logging.getLogger(__name__)
	SCHEMA_WS_DEPOSE_MFA
	SCHEMA_WS_SETUP_MFA
string	WS_TYPE_DEPOSE_MFA = "auth/depose_mfa"
string	WS_TYPE_SETUP_MFA = "auth/setup_mfa"

Detailed Description

Helpers to setup multi-factor auth module.

Function Documentation

_prepare_result_json()

data_entry_flow.FlowResult homeassistant.components.auth.mfa_setup_flow._prepare_result_json ( data_entry_flow.FlowResult  result )

private

Convert result to JSON.

Definition at line 152 of file mfa_setup_flow.py.

async_setup()

None homeassistant.components.auth.mfa_setup_flow.async_setup

(

HomeAssistant

hass

)

Init mfa setup flow manager.

Definition at line 72 of file mfa_setup_flow.py.

websocket_depose_mfa()

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

Remove user from mfa module.

Definition at line 125 of file mfa_setup_flow.py.

websocket_setup_mfa()

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

Return a setup flow for mfa auth module.

Definition at line 87 of file mfa_setup_flow.py.

Variable Documentation

_LOGGER

homeassistant.components.auth.mfa_setup_flow._LOGGER = logging.getLogger(__name__)

private

Definition at line 38 of file mfa_setup_flow.py.

SCHEMA_WS_DEPOSE_MFA

homeassistant.components.auth.mfa_setup_flow.SCHEMA_WS_DEPOSE_MFA

Initial value:

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

Definition at line 32 of file mfa_setup_flow.py.

SCHEMA_WS_SETUP_MFA

homeassistant.components.auth.mfa_setup_flow.SCHEMA_WS_SETUP_MFA

Initial value:

=  vol.All(
    websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
        {
            vol.Required("type"): WS_TYPE_SETUP_MFA,
            vol.Exclusive("mfa_module_id", "module_or_flow_id"): str,
            vol.Exclusive("flow_id", "module_or_flow_id"): str,
            vol.Optional("user_input"): object,
        }
    ),
    cv.has_at_least_one_key("mfa_module_id", "flow_id"),
)

Definition at line 19 of file mfa_setup_flow.py.

WS_TYPE_DEPOSE_MFA

string homeassistant.components.auth.mfa_setup_flow.WS_TYPE_DEPOSE_MFA = "auth/depose_mfa"

Definition at line 31 of file mfa_setup_flow.py.

WS_TYPE_SETUP_MFA

string homeassistant.components.auth.mfa_setup_flow.WS_TYPE_SETUP_MFA = "auth/setup_mfa"

Definition at line 18 of file mfa_setup_flow.py.