homeassistant.components.http.auth Namespace Reference

Functions
None	async_setup_auth (HomeAssistant hass, Application app)
str	async_sign_path (HomeAssistant hass, str path, timedelta expiration, *str|None refresh_token_id=None, bool use_content_user=False)
str|None	async_user_not_allowed_do_auth (HomeAssistant hass, User user, Request|None request=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONTENT_USER_NAME = "Home Assistant Content"
	Final
string	STORAGE_KEY = "http.auth"
int	STORAGE_VERSION = 1

Detailed Description

Authentication for HTTP component.

Function Documentation

async_setup_auth()

None homeassistant.components.http.auth.async_setup_auth	(	HomeAssistant	hass,
		Application	app
	)

Create auth middleware for the app.

Definition at line 120 of file auth.py.

async_sign_path()

str homeassistant.components.http.auth.async_sign_path	(	HomeAssistant	hass,
		str	path,
		timedelta	expiration,
		*str | None	refresh_token_id = None,
		bool	use_content_user = False
	)

Sign a path for temporary access without auth header.

Definition at line 45 of file auth.py.

async_user_not_allowed_do_auth()

str | None homeassistant.components.http.auth.async_user_not_allowed_do_auth	(	HomeAssistant	hass,
		User	user,
		Request | None	request = None
	)

Validate that user is not allowed to do auth things.

Definition at line 89 of file auth.py.

Variable Documentation

_LOGGER

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

private

Definition at line 32 of file auth.py.

CONTENT_USER_NAME

string homeassistant.components.http.auth.CONTENT_USER_NAME = "Home Assistant Content"

Definition at line 41 of file auth.py.

Final

homeassistant.components.http.auth.Final

Definition at line 34 of file auth.py.

STORAGE_KEY

string homeassistant.components.http.auth.STORAGE_KEY = "http.auth"

Definition at line 40 of file auth.py.

STORAGE_VERSION

int homeassistant.components.http.auth.STORAGE_VERSION = 1

Definition at line 39 of file auth.py.