mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
Remove legacy api password auth provider (#30019)
This commit is contained in:
parent
d43d796ed2
commit
eaca91e339
@ -29,8 +29,9 @@ You can supply more than one, for example:
|
||||
homeassistant:
|
||||
auth_providers:
|
||||
- type: homeassistant
|
||||
- type: legacy_api_password
|
||||
api_password: !secret http_password
|
||||
- type: trusted_networks
|
||||
trusted_networks:
|
||||
- 192.168.0.0/24
|
||||
```
|
||||
|
||||
## Available auth providers
|
||||
@ -194,30 +195,3 @@ Any leading and trailing whitespace is stripped from usernames before they're pa
|
||||
<div class='note'>
|
||||
For now, meta variables are only respected the first time a particular user is authenticated. Upon subsequent authentications of the same user, the previously created user object with the old values is reused.
|
||||
</div>
|
||||
|
||||
### Legacy API password
|
||||
|
||||
<div class='note warning'>
|
||||
This is a legacy feature for backwards compatibility and will be dropped in a future release. You should move to one of the other auth providers.
|
||||
</div>
|
||||
|
||||
Activating this auth provider will allow you to authenticate with the API password set in the HTTP integration.
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
auth_providers:
|
||||
- type: legacy_api_password
|
||||
api_password: !secret http_password
|
||||
```
|
||||
|
||||
`api_password` is required option since 0.90 release.
|
||||
|
||||
Activating this auth provider will also allow you to provide the API password using an authentication header to make requests against the Home Assistant API. This feature will be dropped in the future in favor of long-lived access tokens.
|
||||
|
||||
If you don't specify any `auth_providers` section in the `configuration.yaml` file then this provider will be set up automatically if `api_password` was configured under `http` section.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
[Issue 16441](https://github.com/home-assistant/core/issues/16441): the legacy API password auth provider, won't be automatically configured if your API password is located in a package. This is because Home Assistant processes the `auth_provider` during the `core` section loading, which is earlier than the `packages` processing.
|
||||
|
||||
</div>
|
||||
|
@ -12,25 +12,27 @@ The workflow for moving private information to `secrets.yaml` is very similar to
|
||||
The entries for password and API keys in the `configuration.yaml` file usually looks like the example below.
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
auth_providers:
|
||||
- type: legacy_api_password
|
||||
api_password: YOUR_PASSWORD
|
||||
rest:
|
||||
- authentication: basic
|
||||
username: "admin"
|
||||
password: "YOUR_PASSWORD"
|
||||
...
|
||||
```
|
||||
|
||||
Those entries need to be replaced with `!secret` and an identifier.
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
auth_providers:
|
||||
- type: legacy_api_password
|
||||
api_password: !secret http_password
|
||||
rest:
|
||||
- authentication: basic
|
||||
username: "admin"
|
||||
password: !secret rest_password
|
||||
...
|
||||
```
|
||||
|
||||
The `secrets.yaml` file contains the corresponding password assigned to the identifier.
|
||||
|
||||
```yaml
|
||||
http_password: "YOUR_PASSWORD"
|
||||
rest_password: "YOUR_PASSWORD"
|
||||
```
|
||||
|
||||
## Debugging secrets
|
||||
|
Loading…
x
Reference in New Issue
Block a user