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-28 03:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update async sign path docs (#1203)

Browse Source 
* Update async sign path docs

* Fix typo

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Paulus Schoutsen 2022-02-01 03:04:36 -08:00 committed by GitHub
parent 5ef105e921
commit 47ed55f216
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/auth_api.md
View File

@ -234,7 +234,11 @@ Sometimes you want a user to make a GET request to Home Assistant to download da
A signed path is a normal path on our server, like `/api/states`, but with an attached secure authentication signature. The user is able to navigate to this path and will be authorized as the access token that created the signed path. Signed paths can be created via the websocket connection and are meant to be shortlived. The default expiration is 30 seconds.
To get a signed path, send the following command:
There are two ways to get a signed path.
If you are creating an integration, import `async_sign_path` from `homeassistant.components.http.auth`. The method will automatically adopt a refresh token if called from inside the context of an HTTP request or a WebSocket connection. If neither available (ie because inside an automation), it will use a special "Home Assistant Content" user.
If you're working with the frontend, you can create a signed path using the following WebSocket command:
```js
{