Skip to content

Commit

Permalink
Update websocket.md (#2383)
Browse files Browse the repository at this point in the history 
Clarify use of `accessToken` URL param in websocket url.

Signed-off-by: Markus <[email protected]>
  • Loading branch information
@doits
doits authored Oct 18, 2024
1 parent e3baded commit 7ede74f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions configuration/websocket.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ All messages on the WebSocket connection are JSON encoded text-messages.
## Establishing a connection

WebSockets are available on the same ports as the REST API, usually port 8080 for unsecured (ws-protocol) and port 8443 for secured (wss-protocol) connections.
The connection is established by connecting to `ws[s]://{URL}:{PORT}/ws`.
The connection is established by connecting to `ws[s]://{URL}:{PORT}/ws?accessToken={TOKEN}`.

To prevent unauthorized use of the connection an `accessToken` has to be sent with the initial request.
Two authentication methods are available:
{TOKEN} can be one of these two:

1. API token: `oh.ohwstest.tz1IDPniKLxc0VU4t9tz4GiAiKmc0ZDdMKxhlD5tfviQStM4oNsywrcrUTktPbBE9YQ3wnMBrCqVEIhg7Q`
1. An API token: `oh.ohwstest.tz1IDPniKLxc0VU4t9tz4GiAiKmc0ZDdMKxhlD5tfviQStM4oNsywrcrUTktPbBE9YQ3wnMBrCqVEIhg7Q`

1. Basic Auth with username/password: `dXNlcjpwYXNzd29yZA==`
1. Basic Auth with base64 encoded {USER}:{PASSWORD}: `dXNlcjpwYXNzd29yZA==`

## Using the WebSocket connection

Expand Down

0 comments on commit 7ede74f

Please sign in to comment.