Skip to content

[DX-1489] Fix embedded-token JWT requirements on the token auth page #3457

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

Open
umair-ably wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[DX-1489] Fix embedded-token JWT requirements on the token auth page #3457

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f8d9c1
fix: correct embedded-token JWT requirements on auth/token page
umair-ably Jul 3, 2026
457b112
Link "Ably JWT" to its definition in the API reference
umair-ably Jul 3, 2026
1f24c57
Update src/pages/docs/auth/token/index.mdx
umair-ably Jul 3, 2026
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
4 changes: 2 additions & 2 deletions src/pages/docs/auth/token/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,8 @@ If you have an existing [JWT](https://jwt.io/) authentication system, you can em

### Requirements

* The embedded token must be an Ably Token (not a JWT).
* The embedded token is included under the `x-ably-token` key in the [JOSE Header](https://tools.ietf.org/html/rfc7519), or if using JWS, in the payload claims.
* The embedded token can be an [Ably JWT](/docs/api/rest-sdk/authentication#ably-jwt) or an Ably Token.
* Include the token under the `x-ably-token` key in the [JOSE Header](https://tools.ietf.org/html/rfc7519). If the outer JWT is an unencrypted JWS, you can alternatively include it as an `x-ably-token` claim in the payload.
* The expiry time of the embedded token must not be earlier than the outer JWT's expiry time (`exp` claim). Ably will reject any JWT if it is unencrypted and its `exp` claim is later than the expiry of the enclosed token.

### When to use
Expand Down