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-16 05:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document 'force' in external_auth (#387)

Browse Source
This commit is contained in:
Paulus Schoutsen 2020-01-13 06:13:30 -08:00 committed by GitHub
parent 3c61ad3c81
commit 732ee0523b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/frontend_external_auth.md
View File

@ -6,21 +6,25 @@ 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` (for Android) or `window.webkit.messageHandlers` (for iOS) to be defined 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
_This API has been introduced in Home Assistant 0.78._
When the frontend loads, it will request an access token from the external authentication. It does so by calling one of the following methods with an options object. The options object defines the callback method to be called with the response.
When the frontend loads, it will request an access token from the external authentication. It does so by calling one of the following methods with an options object. The options object defines the callback method to be called with the response and an optional `force` boolean which is set to `true` if the access token should be refreshed, regardless if it has expired or not.
The `force` boolean has been introduced in Home Assistant 0.104 and might not always be available.
```js
window.externalApp.getExternalAuth({
callback: 'externalAuthSetToken'
callback: "externalAuthSetToken",
force: true
});
// or
window.webkit.messageHandlers.getExternalAuth.postMessage({
callback: 'externalAuthSetToken'
callback: "externalAuthSetToken",
force: true
});
```
@ -29,8 +33,8 @@ The response should contain a boolean if it was successful and an object contain
```js
// To be called by external app
window.externalAuthSetToken(true, {
"access_token": "qwere",
"expires_in": 1800
access_token: "qwere",
expires_in: 1800
});
// If unable to get new access token
@ -47,11 +51,11 @@ When the user presses the logout button on the profile page, the external app wi
```js
window.externalApp.revokeExternalAuth({
callback: 'externalAuthRevokeToken'
callback: "externalAuthRevokeToken"
});
// or
window.webkit.messageHandlers.revokeExternalAuth.postMessage({
callback: 'externalAuthRevokeToken'
callback: "externalAuthRevokeToken"
});
```