From 8fc9d847b5305fbb07a4e364dfefd57629ea815b Mon Sep 17 00:00:00 2001 From: Allen Porter Date: Sat, 16 Apr 2022 11:49:02 -0700 Subject: [PATCH] Update documentation for developer credentials after PR discussion feedback --- docs/config_entries_config_flow_handler.md | 2 +- docs/core/platform/application_credentials.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config_entries_config_flow_handler.md b/docs/config_entries_config_flow_handler.md index 0ec6d30d..cccfc09c 100644 --- a/docs/config_entries_config_flow_handler.md +++ b/docs/config_entries_config_flow_handler.md @@ -154,7 +154,7 @@ To get started, run `python3 -m script.scaffold config_flow_discovery` and follo Home Assistant has built-in support for integrations that offer account linking using [the OAuth2 authorization framework](https://tools.ietf.org/html/rfc6749). To be able to leverage this, you will need to structure your Python API library in a way that allows Home Assistant to be responsible for refreshing tokens. See our [API library guide](api_lib_index.md) on how to do this. -The built-in OAuth2 support works out of the box with locally configured client ID / secret and with the Home Assistant Cloud Account Linking service. This service allows users to link their account with a centrally managed client ID/secret. If you want your integration to be part of this service, reach out to us at [hello@home-assistant.io](mailto:hello@home-assistant.io). +The built-in OAuth2 support works out of the box with locally configured client ID / secret using the [Application Credentials platform](/docs/core/platform/application_credentials) and with the Home Assistant Cloud Account Linking service. This service allows users to link their account with a centrally managed client ID/secret. If you want your integration to be part of this service, reach out to us at [hello@home-assistant.io](mailto:hello@home-assistant.io). To get started, run `python3 -m script.scaffold config_flow_oauth2` and follow the instructions. This will create all the boilerplate necessary to configure your integration using OAuth2. diff --git a/docs/core/platform/application_credentials.md b/docs/core/platform/application_credentials.md index 333e9ea1..5b7f5b53 100644 --- a/docs/core/platform/application_credentials.md +++ b/docs/core/platform/application_credentials.md @@ -29,7 +29,7 @@ async def async_get_authorization_server( ) ``` -## AuthorizationServer +### AuthorizationServer An `AuthorizationServer` represents the [OAuth2 Authorization server](https://datatracker.ietf.org/doc/html/rfc6749) used for an integration.