jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-06-18 08:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to explain the import API

Browse Source
This commit is contained in:
Allen Porter 2022-04-05 15:14:20 +00:00
parent b2349f5675
commit 7acbe01b38
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/core/platform/application_credentials.md
View File

@ -26,16 +26,10 @@ async def async_get_authorization_server(
authorize_url="https://example.com/auth", authorize_url="https://example.com/auth",
token_url="https://example.com/oauth2/v4/token" token_url="https://example.com/oauth2/v4/token"
) )
# Optional and provided only for backwards compatibility if integration used to
# accept YAML credentials. Return YAML client ID and secret.
async def async_get_client_credential(
self, hass: HomeAssistant
) -> ClientCredential:
"""Return a client credential from configuration.yaml."""
``` ```
See below for details on backwards compatibility with YAML credentials.
## AuthorizationServer ## AuthorizationServer
A `AuthorizationServer` represents the [OAuth2 Authorization server](https://datatracker.ietf.org/doc/html/rfc6749) used for an integration. A `AuthorizationServer` represents the [OAuth2 Authorization server](https://datatracker.ietf.org/doc/html/rfc6749) used for an integration.
@ -45,6 +39,12 @@ A `AuthorizationServer` represents the [OAuth2 Authorization server](https://dat
| authorize_url | str | **Required** | The OAuth authorize URL that the user is redirected to during the configuration flow. | | authorize_url | str | **Required** | The OAuth authorize URL that the user is redirected to during the configuration flow. |
| token_url | str | **Required** | The URL used for obtaining an access token. | | token_url | str | **Required** | The URL used for obtaining an access token. |
## Import YAML credentials
Credentials may be imported by integrations that used to accept YAML credentials using the import API `async_import_client_credential` provided by the application credentials integration.
The `auth_domain` is the domain for the auth implementation in in the config entry, which is typically the domain specified in an existing `LocalOAuth2Implementation`.
## ClientCredential ## ClientCredential
A `ClientCredential` represents the a client credential provided by the user. A `ClientCredential` represents the a client credential provided by the user.