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-25 02:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update external auth (#83)

Browse Source
This commit is contained in:
Paulus Schoutsen 2018-09-11 10:24:09 +02:00 committed by GitHub
parent 220f6e5f0b
commit 4ea6246370
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/frontend_external_auth.md
View File

@ -6,7 +6,7 @@ By default, the frontend will take care of its own authentication tokens. If non
If you want to embed the Home Assistant frontend in an external app, you will want to store the authentication inside the app but make it available to the frontend. To support this, Home Assistant exposes an external authentication API.
To activate this API, load the frontend with `?external_auth=1` appended to the URL. If this is passed in, Home Assistant will expect either `window.externalApp` to be defined or `window.webkit.messageHandlers` containing the methods described below.
To activate this API, load the frontend with `?external_auth=1` appended to the URL. If this is passed in, Home Assistant will expect either `window.externalApp` (for Android) or `window.webkit.messageHandlers` (for iOS) to be defined containing the methods described below.
## Get Access Token
@ -24,14 +24,17 @@ window.webkit.messageHandlers.getExternalAuth.postMessage({
});
```
The response should contain an access token and the number of seconds that it will remain valid. Pass the response to the function defined in the options object.
The response should contain a boolean if it was successful and an object containing an access token and the number of seconds that it will remain valid. Pass the response to the function defined in the options object.
```js
// To be called by external app
window.externalAuthSetToken({
window.externalAuthSetToken(true, {
"access_token": "qwere",
"expires_in": 1800
});
// If unable to get new access token
window.externalAuthSetToken(false);
```
The frontend will call this method when the page first loads and whenever it needs a valid token but the previous received token has expired.
@ -56,5 +59,8 @@ When done, the external app has to call the function defined in the options obje
```js
// To be called by external app
window.externalAuthRevokeToken();
window.externalAuthRevokeToken(true);
// If unable to logout
window.externalAuthRevokeToken(false);
```