Collaboration diagram for homeassistant.auth.mfa_modules.MultiFactorAuthModule:

[legend]

Public Member Functions
None	__init__ (self, HomeAssistant hass, dict[str, Any] config)

None	async_depose_user (self, str user_id)

bool	async_is_user_setup (self, str user_id)

SetupFlow	async_setup_flow (self, str user_id)

Any	async_setup_user (self, str user_id, Any setup_data)

bool	async_validate (self, str user_id, dict[str, Any] user_input)

str	id (self)

vol.Schema	input_schema (self)

str	name (self)

str	type (self)

Public Attributes
	config

	hass

Static Public Attributes
string	DEFAULT_TITLE = "Unnamed auth module"

int	MAX_RETRY_TIME = 3

Detailed Description

Multi-factor Auth Module of validation function.

Definition at line 38 of file __init__.py.

Constructor & Destructor Documentation

◆ init()

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

Initialize an auth module.

Definition at line 44 of file __init__.py.

Member Function Documentation

◆ async_depose_user()

None homeassistant.auth.mfa_modules.MultiFactorAuthModule.async_depose_user	(		self,
		str	user_id
	)

Remove user from mfa module.

Definition at line 85 of file __init__.py.

◆ async_is_user_setup()

bool homeassistant.auth.mfa_modules.MultiFactorAuthModule.async_is_user_setup	(		self,
		str	user_id
	)

Return whether user is setup.

Definition at line 89 of file __init__.py.

◆ async_setup_flow()

SetupFlow homeassistant.auth.mfa_modules.MultiFactorAuthModule.async_setup_flow	(		self,
		str	user_id
	)

Return a data entry flow handler for setup module.

Mfa module should extend SetupFlow

Definition at line 74 of file __init__.py.

◆ async_setup_user()

Any homeassistant.auth.mfa_modules.MultiFactorAuthModule.async_setup_user	(		self,
		str	user_id,
		Any	setup_data
	)

Set up user for mfa auth module.

Definition at line 81 of file __init__.py.

◆ async_validate()

bool homeassistant.auth.mfa_modules.MultiFactorAuthModule.async_validate	(		self,
		str	user_id,
		dict[str, Any]	user_input
	)

Return True if validation passed.

Definition at line 93 of file __init__.py.

◆ id()

str homeassistant.auth.mfa_modules.MultiFactorAuthModule.id ( self )

Return id of the auth module.

Default is same as type

Definition at line 50 of file __init__.py.

◆ input_schema()

vol.Schema homeassistant.auth.mfa_modules.MultiFactorAuthModule.input_schema ( self )

Return a voluptuous schema to define mfa auth module's input.

Definition at line 70 of file __init__.py.

◆ name()

str homeassistant.auth.mfa_modules.MultiFactorAuthModule.name ( self )

Return the name of the auth module.

Definition at line 63 of file __init__.py.

◆ type()

str homeassistant.auth.mfa_modules.MultiFactorAuthModule.type ( self )

Return type of the module.

Definition at line 58 of file __init__.py.

Member Data Documentation

◆ config

homeassistant.auth.mfa_modules.MultiFactorAuthModule.config

Definition at line 47 of file __init__.py.

◆ DEFAULT_TITLE

string homeassistant.auth.mfa_modules.MultiFactorAuthModule.DEFAULT_TITLE = "Unnamed auth module"

static

Definition at line 41 of file __init__.py.

◆ hass

homeassistant.auth.mfa_modules.MultiFactorAuthModule.hass

Definition at line 46 of file __init__.py.

◆ MAX_RETRY_TIME

int homeassistant.auth.mfa_modules.MultiFactorAuthModule.MAX_RETRY_TIME = 3