Skip to content

Commit 68298c5

Browse files
awarecanfrenck
authored andcommitted
Deprecated http.api_password (home-assistant#8894)
* Update providers.markdown * Update http.markdown * Update http.markdown * Update source/_components/http.markdown Co-Authored-By: awarecan <awarecan@users.noreply.github.com> * Update source/_components/http.markdown Co-Authored-By: awarecan <awarecan@users.noreply.github.com>
1 parent 81cd16d commit 68298c5

File tree

2 files changed

+5
-12
lines changed

2 files changed

+5
-12
lines changed

source/_components/http.markdown

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,11 @@ Don't use option `server_host` on a Hass.io installation!
2222
```yaml
2323
# Example configuration.yaml entry
2424
http:
25-
api_password: YOUR_PASSWORD
2625
```
2726
2827
{% configuration %}
2928
api_password:
30-
description: Protect the Home Assistant API with a password - this password can also be used to log in to the frontend. Where your client or other software supports it, you should use [long lasting access token](/docs/authentication/#your-account-profile) instead, as [shown in the REST API](https://developers.home-assistant.io/docs/en/external_api_rest.html) and [websocket API](https://developers.home-assistant.io/docs/en/external_api_websocket.html) documentation.
29+
description: "**Deprecated since 0.90 release. Configuration moved to [Legacy API password auth provider](/docs/authentication/providers/#legacy-api-password).** Protect the Home Assistant API with a password - this password can also be used to log in to the frontend. Where your client or other software supports it, you should use [long lasting access token](/docs/authentication/#your-account-profile) instead, as [shown in the REST API](https://developers.home-assistant.io/docs/en/external_api_rest.html) and [websocket API](https://developers.home-assistant.io/docs/en/external_api_websocket.html) documentation."
3130
required: false
3231
type: string
3332
server_host:
@@ -71,7 +70,7 @@ trusted_proxies:
7170
required: false
7271
type: string, list
7372
trusted_networks:
74-
description: "List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. If using a reverse proxy with the `use_x_forwarded_for` and `trusted_proxies` options enabled, requests proxied to Home Assistant with a trusted `X-Forwarded-For` header will appear to come from the IP given in that header instead of the proxy IP."
73+
description: "**Deprecated since 0.89 release. Configuration moved to [Trusted Networks auth provider](/docs/authentication/providers/#trusted-networks).** List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. If using a reverse proxy with the `use_x_forwarded_for` and `trusted_proxies` options enabled, requests proxied to Home Assistant with a trusted `X-Forwarded-For` header will appear to come from the IP given in that header instead of the proxy IP."
7574
required: false
7675
type: string, list
7776
ip_ban_enabled:
@@ -96,7 +95,6 @@ The sample below shows a configuration entry with possible values:
9695
```yaml
9796
# Example configuration.yaml entry
9897
http:
99-
api_password: YOUR_PASSWORD
10098
server_port: 12345
10199
ssl_certificate: /etc/letsencrypt/live/hass.example.com/fullchain.pem
102100
ssl_key: /etc/letsencrypt/live/hass.example.com/privkey.pem
@@ -107,11 +105,6 @@ http:
107105
trusted_proxies:
108106
- 127.0.0.1
109107
- ::1
110-
trusted_networks:
111-
- 127.0.0.1
112-
- ::1
113-
- 192.168.0.0/24
114-
- fd00::/8
115108
ip_ban_enabled: true
116109
login_attempts_threshold: 5
117110
```

source/_docs/authentication/providers.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ Activating this auth provider will allow you to authenticate with the API passwo
132132
homeassistant:
133133
auth_providers:
134134
- type: legacy_api_password
135-
136-
http:
137-
api_password: !secret http_password
135+
api_password: !secret http_password
138136
```
139137

138+
`api_password` is required option since 0.90 rlease.
139+
140140
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.
141141

142142
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.

0 commit comments

Comments
 (0)