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-04-27 14:57:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove legacy API from websocket API docs (#589)

Browse Source
This commit is contained in:
Paulus Schoutsen 2020-06-30 00:14:40 -07:00 committed by GitHub
parent 88849ebcc5
commit f6c0952b01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/api/websocket.md
View File

@ -57,17 +57,7 @@ Example of an auth message:
## Authentication phase
When a client connects to the server, the server will test if the client is authenticated. Authentication will not be necessary if no api_password is set or if the user fulfills one of the other criteria for authentication (trusted network, password in url/header).
If no authentication is needed, the authentication phase will complete and the server will send an `auth_ok` message.
```json
{
"type": "auth_ok"
}
```
If authentication is necessary, the server sends out `auth_required`.
When a client connects to the server, the server sends out `auth_required`.
```json
{
@ -75,7 +65,7 @@ If authentication is necessary, the server sends out `auth_required`.
}
```
This means that the next message from the client should be an auth message. You can authorize with an access token.
The first message from the client should be an auth message. You can authorize with an access token.
```json
{
@ -84,15 +74,6 @@ This means that the next message from the client should be an auth message. You
}
```
For now, we also support authentication with an API password (legacy auth).
```json
{
"type": "auth",
"api_password": "supersecret"
}
```
If the client supplies valid authentication, the authentication phase will complete by the server sending the `auth_ok` message:
```json