website/docs: add docs for websocket connections

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-08-29 19:49:18 +02:00
parent 523b96a6d2
commit 87920fb1d7
7 changed files with 62 additions and 16 deletions

View File

@ -0,0 +1,48 @@
---
title: Websocket API
---
authentik has two different WebSocket endpoints, one is used for web-based clients to get real-time updates, and the other is used for outposts to report their healthiness.
### Web `/ws/client/`
:::info
Authentication is done using the session, so make sure to send the `Cookie` header.
:::
All messages have a common field called `message_type` to discern the type of message.
#### `message` type:
This type is used when the backend has a notice to show to the user. A full payload looks like:
```json
{
"message_type": "message",
"level": "error" | "warning" | "success" | "info",
"tags": "",
"message": "a message",
}
```
### Outpost `/ws/outpost/<outpost-uuid>/`
:::info
Authentication is done via the `Authorization` header, same as the regular API. You must send a valid token with a `Bearer ` prefix.
:::
All messages have two fields, `instruction` and `args`. Instruction is any number from this list:
- `0`: ACK, simply acknowledges the previous message
- `1`: HELLO, used for monitoring and regularly sent by outposts
- `2`: TRIGGER_UPDATE, sent by authentik to trigger a reload of the configuration
Arguments for these messages vary, all though these common args are always sent:
- `args['uuid']`: A unique UUID generated on startup of an outpost, used to uniquely identify it.
These fields are only sent for HELLO instructions:
- `args['version']`: Version of the outpost
- `args['buildHash']`: Build hash of the outpost, when available

View File

@ -5,28 +5,26 @@ module.exports = {
id: "index", id: "index",
}, },
{ {
type: "doc", type: "category",
id: "full-dev-environment", label: "Setup",
items: [
"api/api",
"api/flow-executor",
"api/making-schema-changes",
"api/websocket",
],
}, },
{ {
type: "doc", type: "category",
id: "frontend-only-dev-environment", label: "Setup",
}, items: [
{ "setup/full-dev-environment",
type: "doc", "setup/frontend-only-dev-environment",
id: "making-schema-changes", ],
},
{
type: "doc",
id: "api",
}, },
{ {
type: "doc", type: "doc",
id: "translation", id: "translation",
}, },
{
type: "doc",
id: "flow-executor",
},
], ],
}; };