home-assistant.io/source/_integrations/application_credentials.markdown
Allen Porter d9e227fec5
Add documentation for application credentials (#22847)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2022-05-30 19:40:32 +02:00

1.4 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
@home-assistant/core
integration

The Application Credentials 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.

Manual Setup

Note that integrations that do not support cloud linking will prompt to setup Application Credentials when setting up for the first time. You may also manually enter credentials with the following steps:

  1. Obtain an OAuth Client ID and Client Secret from the cloud provider. The integration should have specific instructions for this.
  2. In Home Assistant navigate to Settings -> Devices & Services
  3. Click the overflow menu ... and choose Application Credentials
  4. Select the integration, enter a Name and your OAuth Client ID and Client Secret.
  5. Save the credentials

You may then visit Integrations and setup the integration.