2.8 KiB
| title | description | ha_release | ha_domain | ha_quality_scale | ha_category | ha_codeowners | ha_integration_type | |
|---|---|---|---|---|---|---|---|---|
| Application credentials | Allows users to link accounts with integrations that support OAuth2 | 2022.6 | application_credentials | internal |
|
system |
The Application credentials {% term integration %} is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however, not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking.
Automatic setup
Some integrations like Google Calendar will automatically create application credentials as part of adding an integration.
To view stored application credentials
-
Go to {% my integrations title="Settings > Devices & services" %}.
-
In the top right corner, select the three dots {% icon "mdi:dots-vertical" %} menu and select Application credentials.
Manual setup
Some integrations do not support cloud linking. They will prompt you to set up Application Credentials when setting up for the first time. You may also manually enter credentials with the following steps:
-
Obtain an OAuth Client ID and Client Secret from the cloud provider. The integration should have specific instructions for this.
-
In Home Assistant, go to {% my integrations title="Settings > Devices & services" %}.
-
In the top right corner, select the three dots {% icon "mdi:dots-vertical" %} menu and select Application credentials.
-
Select the integration, enter a Name and your OAuth Client ID and Client Secret.
-
Save the credentials.
-
You may then visit Integrations and set up the integration.
Deleting application credentials
To delete an application credential, for example because you created a new one, follow these steps:
-
Go to {% my integrations title="Settings > Devices & services" %}.
-
In the top right corner, select the three dots {% icon "mdi:dots-vertical" %} menu and select Application credentials.
-
Select the credential from the list, select the three-dots menu and select Delete.
