homeassistant.auth.mfa_modules.insecure_example.InsecureExampleModule Class Reference

Inheritance diagram for homeassistant.auth.mfa_modules.insecure_example.InsecureExampleModule:

Collaboration diagram for homeassistant.auth.mfa_modules.insecure_example.InsecureExampleModule:

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)
vol.Schema	input_schema (self)
vol.Schema	setup_schema (self)

Static Public Attributes
string	DEFAULT_TITLE = "Insecure Personal Identify Number"

Private Attributes
	_data

Detailed Description

Example auth module validate pin.

Definition at line 29 of file insecure_example.py.

Constructor & Destructor Documentation

__init__()

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

Initialize the user data store.

Definition at line 34 of file insecure_example.py.

Member Function Documentation

async_depose_user()

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

Remove user from mfa module.

Definition at line 69 of file insecure_example.py.

async_is_user_setup()

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

Return whether user is setup.

Definition at line 79 of file insecure_example.py.

async_setup_flow()

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

Return a data entry flow handler for setup module.

Mfa module should extend SetupFlow

Definition at line 49 of file insecure_example.py.

async_setup_user()

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

Set up user to use mfa module.

Definition at line 56 of file insecure_example.py.

async_validate()

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

Return True if validation passed.

Definition at line 83 of file insecure_example.py.

input_schema()

vol.Schema homeassistant.auth.mfa_modules.insecure_example.InsecureExampleModule.input_schema

(

self

)

Validate login flow input data.

Definition at line 40 of file insecure_example.py.

setup_schema()

vol.Schema homeassistant.auth.mfa_modules.insecure_example.InsecureExampleModule.setup_schema

(

self

)

Validate async_setup_user input data.

Definition at line 45 of file insecure_example.py.

Member Data Documentation

_data

homeassistant.auth.mfa_modules.insecure_example.InsecureExampleModule._data

private

Definition at line 37 of file insecure_example.py.

DEFAULT_TITLE

string homeassistant.auth.mfa_modules.insecure_example.InsecureExampleModule.DEFAULT_TITLE = "Insecure Personal Identify Number"

static

Definition at line 32 of file insecure_example.py.

---

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

• core/homeassistant/auth/mfa_modules/insecure_example.py