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-07-15 13:26:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tweak "Long-Lived Access Tokens" documentation (#716)

Browse Source 
It's much easier to grab a long-lived access token via the web frontend, so mention that *first*.

It appears that the previous ordering was just an artifact of the fact that web frontend support was added later than websocket support. See #151.
This commit is contained in:
Adam Ernst 2020-11-08 05:45:06 -06:00 committed by GitHub
parent 5e2625c381
commit a7b2715c76
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/auth_api.md
View File

@ -148,9 +148,9 @@ The request will always respond with an empty body and HTTP status 200, regardle
## Long-lived access token ## Long-lived access token
A long-lived access token is usually used for 3rd party API calls and webhook-ish integrations. To generate a long-lived access token, an active websocket connection has to be established. Long-lived access tokens are valid for 10 years. These are useful for integrating with third-party APIs and webhook-style integrations. Long-lived access tokens can be created using the **"Long-Lived Access Tokens"** section at the bottom of a user's Home Assistant profile page.
Send websocket command `auth/long_lived_access_token` will create a long-lived access token for current user. Access token will not be saved in Home Assistant. User need to record the token in secure place. You can also generate a long-lived access token using the websocket command `auth/long_lived_access_token`, which will create a long-lived access token for current user. The access token string is not saved in Home Assistant; you must record it in a secure place.
```json ```json
{ {
@ -162,7 +162,7 @@ Send websocket command `auth/long_lived_access_token` will create a long-lived a
} }
``` ```
Result will be a long-lived access token: The response includes a long-lived access token:
```json ```json
{ {
@ -173,8 +173,6 @@ Result will be a long-lived access token:
} }
``` ```
Additionally, a long-lived access token can be created using the UI tool located at the bottom of the user's Home Assistant profile page.
## Making authenticated requests ## Making authenticated requests
Once you have an access token, you can make authenticated requests to the Home Assistant APIs. Once you have an access token, you can make authenticated requests to the Home Assistant APIs.