Skip to content

Added oauth as a valid token_type #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
styler merged 1 commit into from
Sep 27, 2023
Merged

Added oauth as a valid token_type #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/websockets/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following parameters are used in a client-to-server request:
| `nonce` | `string` | A unique identifier for the request. Useful for identifying the corresponding response (Optional). |
| `data.topic` | `string` | The topic to which the client wishes to subscribe. |
| `data.token` | `string` | The token used to authenticate the request. |
| `data.token_type` | `string` | Specifies the type of token. Valid options are `apikey` and `jwt`. |
| `data.token_type` | `string` | Specifies the type of token. Valid options are `apikey`, `jwt` and `oauth`. |

Here is an example of a client-to-server request:

Expand Down Expand Up @@ -52,7 +52,10 @@ Here is an example of a server-to-client response:
"ts": "2023-09-20T16:43:21Z",
"type": "response",
"nonce": "86ccb2b3-eb8d-4b3c-902d-509c3f5ca88c",
"data": "successfully subscribed to topic"
"data": {
"message": "successfully subscribed to topic",
"topic": "channel.follow"
}
}
```

Expand Down