homeassistant.auth.mfa_modules.notify.NotifyAuthModule Class Reference

Inheritance diagram for homeassistant.auth.mfa_modules.notify.NotifyAuthModule:

Collaboration diagram for homeassistant.auth.mfa_modules.notify.NotifyAuthModule:

Public Member Functions
None	__init__ (self, HomeAssistant hass, dict[str, Any] config)
None	async_depose_user (self, str user_id)
None	async_initialize_login_mfa_step (self, str user_id)
bool	async_is_user_setup (self, str user_id)
None	async_notify (self, str code, str notify_service, str|None target=None)
None	async_notify_user (self, str user_id, str code)
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)
list[str]	aync_get_available_notify_services (self)
vol.Schema	input_schema (self)

Static Public Attributes
string	DEFAULT_TITLE = "Notify One-Time Password"

Private Member Functions
None	_async_load (self)
None	_async_save (self)

Private Attributes
	_exclude
	_include
	_init_lock
	_message_template
	_user_settings
	_user_store

Detailed Description

Auth module send hmac-based one time password by notify service.

Definition at line 95 of file notify.py.

Constructor & Destructor Documentation

__init__()

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

Initialize the user data store.

Definition at line 100 of file notify.py.

Member Function Documentation

_async_load()

None homeassistant.auth.mfa_modules.notify.NotifyAuthModule._async_load (   self )

private

Load stored data.

Definition at line 117 of file notify.py.

_async_save()

None homeassistant.auth.mfa_modules.notify.NotifyAuthModule._async_save (   self )

private

Save data.

Definition at line 131 of file notify.py.

async_depose_user()

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

Depose auth module for user.

Definition at line 187 of file notify.py.

async_initialize_login_mfa_step()

None homeassistant.auth.mfa_modules.notify.NotifyAuthModule.async_initialize_login_mfa_step	(		self,
		str	user_id
	)

Generate code and notify user.

Definition at line 221 of file notify.py.

async_is_user_setup()

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

Return whether user is setup.

Definition at line 196 of file notify.py.

async_notify()

None homeassistant.auth.mfa_modules.notify.NotifyAuthModule.async_notify	(		self,
		str	code,
		str	notify_service,
		str | None	target = None
	)

Send code by notify service.

Definition at line 260 of file notify.py.

async_notify_user()

None homeassistant.auth.mfa_modules.notify.NotifyAuthModule.async_notify_user	(		self,
		str	user_id,
		str	code
	)

Send code by user's notify service.

Definition at line 244 of file notify.py.

async_setup_flow()

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

Return a data entry flow handler for setup module.

Mfa module should extend SetupFlow

Definition at line 165 of file notify.py.

async_setup_user()

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

Set up auth module for user.

Definition at line 174 of file notify.py.

async_validate()

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

Return True if validation passed.

Definition at line 204 of file notify.py.

aync_get_available_notify_services()

list[str] homeassistant.auth.mfa_modules.notify.NotifyAuthModule.aync_get_available_notify_services

(

self

)

Return list of notify services.

Definition at line 152 of file notify.py.

input_schema()

vol.Schema homeassistant.auth.mfa_modules.notify.NotifyAuthModule.input_schema

(

self

)

Validate login flow input data.

Definition at line 113 of file notify.py.

Member Data Documentation

_exclude

homeassistant.auth.mfa_modules.notify.NotifyAuthModule._exclude

private

Definition at line 108 of file notify.py.

_include

homeassistant.auth.mfa_modules.notify.NotifyAuthModule._include

private

Definition at line 107 of file notify.py.

_init_lock

homeassistant.auth.mfa_modules.notify.NotifyAuthModule._init_lock

private

Definition at line 110 of file notify.py.

_message_template

homeassistant.auth.mfa_modules.notify.NotifyAuthModule._message_template

private

Definition at line 109 of file notify.py.

_user_settings

homeassistant.auth.mfa_modules.notify.NotifyAuthModule._user_settings

private

Definition at line 126 of file notify.py.

_user_store

homeassistant.auth.mfa_modules.notify.NotifyAuthModule._user_store

private

Definition at line 104 of file notify.py.

DEFAULT_TITLE

string homeassistant.auth.mfa_modules.notify.NotifyAuthModule.DEFAULT_TITLE = "Notify One-Time Password"

static

Definition at line 98 of file notify.py.

---

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

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