homeassistant.auth.providers.LoginFlow Class Reference

Inheritance diagram for homeassistant.auth.providers.LoginFlow:

Collaboration diagram for homeassistant.auth.providers.LoginFlow:

Public Member Functions
None	__init__ (self, AuthProvider auth_provider)
AuthFlowResult	async_finish (self, Any flow_result)
AuthFlowResult	async_step_init (self, dict[str, str]|None user_input=None)
AuthFlowResult	async_step_mfa (self, dict[str, str]|None user_input=None)
AuthFlowResult	async_step_select_mfa_module (self, dict[str, str]|None user_input=None)
Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
vol.Schema	add_suggested_values_to_schema (self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
_FlowResultT	async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
None	async_cancel_progress_task (self)
_FlowResultT	async_create_entry (self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step (self, *str|None step_id=None, str url, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step_done (self, *str next_step_id)
asyncio.Task[Any]|None	async_get_progress_task (self)
None	async_remove (self)
None	async_set_progress_task (self, asyncio.Task[Any] progress_task)
_FlowResultT	async_show_form (self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT	async_show_menu (self, *str|None step_id=None, Container[str] menu_options, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_show_progress (self, *str|None step_id=None, str progress_action, Mapping[str, str]|None description_placeholders=None, asyncio.Task[Any]|None progress_task=None)
_FlowResultT	async_show_progress_done (self, *str next_step_id)
bool	show_advanced_options (self)
str|None	source (self)

Public Attributes
	created_at
	invalid_mfa_times
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

Private Attributes
	_auth_manager
	_auth_module_id
	_auth_provider

Static Private Attributes
	_flow_result = AuthFlowResult

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)
Static Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	Any
bool	deprecated_show_progress = False
	HomeAssistant
string	init_step = "init"
int	MINOR_VERSION = 1
	None
	str
int	VERSION = 1

Detailed Description

Handler for the login flow.

Definition at line 195 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.auth.providers.LoginFlow.__init__	(		self,
		AuthProvider	auth_provider
	)

Initialize the login flow.

Definition at line 200 of file __init__.py.

Member Function Documentation

async_finish()

AuthFlowResult homeassistant.auth.providers.LoginFlow.async_finish	(		self,
		Any	flow_result
	)

Handle the pass of login flow.

Definition at line 298 of file __init__.py.

async_step_init()

AuthFlowResult homeassistant.auth.providers.LoginFlow.async_step_init	(		self,
		dict[str, str] | None	user_input = None
	)

Handle the first step of login flow.

Return self.async_show_form(step_id='init') if user_input is None.
Return await self.async_finish(flow_result) if login init step pass.

Definition at line 211 of file __init__.py.

async_step_mfa()

AuthFlowResult homeassistant.auth.providers.LoginFlow.async_step_mfa	(		self,
		dict[str, str] | None	user_input = None
	)

Handle the step of mfa validation.

Definition at line 246 of file __init__.py.

async_step_select_mfa_module()

AuthFlowResult homeassistant.auth.providers.LoginFlow.async_step_select_mfa_module	(		self,
		dict[str, str] | None	user_input = None
	)

Handle the step of select mfa module.

Definition at line 221 of file __init__.py.

Member Data Documentation

_auth_manager

homeassistant.auth.providers.LoginFlow._auth_manager

private

Definition at line 204 of file __init__.py.

_auth_module_id

homeassistant.auth.providers.LoginFlow._auth_module_id

private

Definition at line 230 of file __init__.py.

_auth_provider

homeassistant.auth.providers.LoginFlow._auth_provider

private

Definition at line 202 of file __init__.py.

_flow_result

homeassistant.auth.providers.LoginFlow._flow_result = AuthFlowResult

staticprivate

Handler for the login flow.

Definition at line 198 of file __init__.py.

created_at

homeassistant.auth.providers.LoginFlow.created_at

Definition at line 206 of file __init__.py.

invalid_mfa_times

homeassistant.auth.providers.LoginFlow.invalid_mfa_times

Definition at line 207 of file __init__.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/auth/providers/__init__.py