homeassistant.components.application_credentials Namespace Reference

Classes
class	ApplicationCredentialsProtocol
class	ApplicationCredentialsStorageCollection
class	AuthImplementation
class	AuthorizationServer
class	ClientCredential

Functions
str|None	_async_config_entry_app_credentials (HomeAssistant hass, ConfigEntry config_entry)
dict[str, Any]	_async_integration_config (HomeAssistant hass, str domain)
list[config_entry_oauth2_flow.AbstractOAuth2Implementation]	_async_provide_implementation (HomeAssistant hass, str domain)
ApplicationCredentialsProtocol|None	_get_platform (HomeAssistant hass, str integration_domain)
None	async_import_client_credential (HomeAssistant hass, str domain, ClientCredential credential, str|None auth_domain=None)
bool	async_setup (HomeAssistant hass, ConfigType config)
None	handle_config_entry (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	handle_integration_list (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)

Variables
list	__all__ = ["ClientCredential", "AuthorizationServer", "async_import_client_credential"]
	_LOGGER = logging.getLogger(__name__)
string	CONF_AUTH_DOMAIN = "auth_domain"
	CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
string	DEFAULT_IMPORT_NAME = "Import from configuration.yaml"
string	DOMAIN = "application_credentials"
string	STORAGE_KEY = DOMAIN
int	STORAGE_VERSION = 1
	VolDictType

Detailed Description

The Application Credentials integration.

This integration provides APIs for managing local OAuth credentials on behalf
of other integrations. Integrations register an authorization server, and then
the APIs are used to add one or more client credentials. Integrations may also
provide credentials from yaml for backwards compatibility.

Function Documentation

_async_config_entry_app_credentials()

str | None homeassistant.components.application_credentials._async_config_entry_app_credentials ( HomeAssistant  hass, ConfigEntry  config_entry  )

private

Return the item id of an application credential for an existing ConfigEntry.

Definition at line 238 of file __init__.py.

_async_integration_config()

dict[str, Any] homeassistant.components.application_credentials._async_integration_config ( HomeAssistant  hass, str  domain  )

private

Definition at line 311 of file __init__.py.

_async_provide_implementation()

list[config_entry_oauth2_flow.AbstractOAuth2Implementation] homeassistant.components.application_credentials._async_provide_implementation ( HomeAssistant  hass, str   domain  )

private

Return registered OAuth implementations.

Definition at line 216 of file __init__.py.

_get_platform()

ApplicationCredentialsProtocol | None homeassistant.components.application_credentials._get_platform ( HomeAssistant  hass, str   integration_domain  )

private

Register an application_credentials platform.

Definition at line 283 of file __init__.py.

async_import_client_credential()

None homeassistant.components.application_credentials.async_import_client_credential	(	HomeAssistant	hass,
		str	domain,
		ClientCredential	credential,
		str | None	auth_domain = None
	)

Import an existing credential from configuration.yaml.

Definition at line 170 of file __init__.py.

async_setup()

bool homeassistant.components.application_credentials.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up Application Credentials.

Definition at line 144 of file __init__.py.

handle_config_entry()

None homeassistant.components.application_credentials.handle_config_entry	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Return application credentials information for a config entry.

Definition at line 344 of file __init__.py.

handle_integration_list()

None homeassistant.components.application_credentials.handle_integration_list	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle integrations command.

Definition at line 323 of file __init__.py.

Variable Documentation

__all__

list homeassistant.components.application_credentials.__all__ = ["ClientCredential", "AuthorizationServer", "async_import_client_credential"]

private

Definition at line 41 of file __init__.py.

_LOGGER

homeassistant.components.application_credentials._LOGGER = logging.getLogger(__name__)

private

Definition at line 43 of file __init__.py.

CONF_AUTH_DOMAIN

string homeassistant.components.application_credentials.CONF_AUTH_DOMAIN = "auth_domain"

Definition at line 50 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.application_credentials.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Definition at line 62 of file __init__.py.

DEFAULT_IMPORT_NAME

string homeassistant.components.application_credentials.DEFAULT_IMPORT_NAME = "Import from configuration.yaml"

Definition at line 51 of file __init__.py.

DOMAIN

string homeassistant.components.application_credentials.DOMAIN = "application_credentials"

Definition at line 45 of file __init__.py.

STORAGE_KEY

string homeassistant.components.application_credentials.STORAGE_KEY = DOMAIN

Definition at line 47 of file __init__.py.

STORAGE_VERSION

int homeassistant.components.application_credentials.STORAGE_VERSION = 1

Definition at line 48 of file __init__.py.

VolDictType

homeassistant.components.application_credentials.VolDictType

Definition at line 53 of file __init__.py.