From d9e227fec51f297d456e0edab0549d546c47c890 Mon Sep 17 00:00:00 2001 From: Allen Porter Date: Mon, 30 May 2022 04:02:10 -0700 Subject: [PATCH] Add documentation for application credentials (#22847) Co-authored-by: Franck Nijhof --- .../application_credentials.markdown | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 source/_integrations/application_credentials.markdown diff --git a/source/_integrations/application_credentials.markdown b/source/_integrations/application_credentials.markdown new file mode 100644 index 00000000000..98b45035c8d --- /dev/null +++ b/source/_integrations/application_credentials.markdown @@ -0,0 +1,26 @@ +--- +title: Application Credentials +description: Allows users to link accounts with integrations that support OAuth2 +ha_release: 2022.6 +ha_domain: application_credentials +ha_quality_scale: internal +ha_category: [] +ha_codeowners: + - '@home-assistant/core' +ha_integration_type: 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. \ No newline at end of file