Skip to content

Commit 0f74f28

Browse files
committed
DOC: notes on authentication for web sockets
1 parent 6f34c6f commit 0f74f28

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/source/control_re_manager.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -444,3 +444,7 @@ Message format for system info messages::
444444
For example, the following format is used for status messages::
445445

446446
{"time": <timestamp>, "msg": {"status": {<RE-Manager-status>}}}
447+
448+
Websockets support authentication using API keys. If a client is using tokens to access API,
449+
the client must request a short-lived API key and use it to connect to the websocket.
450+
Once the connection is established, the client should revoke the API key.

0 commit comments

Comments
 (0)