homeassistant.components.websocket_api.auth Namespace Reference

Classes
class	AuthPhase

Functions
bytes	auth_invalid_message (str message)

Variables
	AUTH_OK_MESSAGE = json_bytes({"type": TYPE_AUTH_OK, "ha_version": __version__})
	AUTH_REQUIRED_MESSAGE
	Final

Detailed Description

Handle the auth of a connection.

Function Documentation

auth_invalid_message()

bytes homeassistant.components.websocket_api.auth.auth_invalid_message

(

str

message

)

Return an auth_invalid message.

Definition at line 44 of file auth.py.

Variable Documentation

AUTH_OK_MESSAGE

homeassistant.components.websocket_api.auth.AUTH_OK_MESSAGE = json_bytes({"type": TYPE_AUTH_OK, "ha_version": __version__})

Definition at line 38 of file auth.py.

AUTH_REQUIRED_MESSAGE

homeassistant.components.websocket_api.auth.AUTH_REQUIRED_MESSAGE

Initial value:

=  json_bytes(
    {"type": TYPE_AUTH_REQUIRED, "ha_version": __version__}
)

Definition at line 39 of file auth.py.

Final

homeassistant.components.websocket_api.auth.Final

Definition at line 25 of file auth.py.