Skip to content

[NO MERGE] Clarify user claim handling for presence and annotations #3200

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
AndyTWF wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[NO MERGE] Clarify user claim handling for presence and annotations #3200

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
4 changes: 3 additions & 1 deletion src/pages/docs/auth/capabilities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,9 @@ Capabilities are determined for [Ably JWTs](/docs/auth/token#jwt) in the followi

It is possible for JWTs to contain authenticated claims for users that can be used to allow or disallow certain interactions in your channels.

Messages can be annotated with trusted metadata copied from the client's authentication token by Ably servers. Clients are unable to directly publish messages with user claim metadata, and claims contained within the authentication token are signed to prevent tampering. Claims can be scoped to individual channels or to namespaces of [channels](/docs/channels). The most specific user claim will be added to the message as part of the `extras` object. Note that this does not apply to presence or metadata messages.
Messages can be annotated with trusted metadata copied from the client's authentication token by Ably servers. Clients are unable to directly publish messages with user claim metadata, and claims contained within the authentication token are signed to prevent tampering. Claims can be scoped to individual channels or to namespaces of [channels](/docs/channels). The most specific user claim will be added to the message as part of the `extras` object.

Custom restrictions also apply to presence messages and individual annotations. In both cases, the user claim is included in `extras.userClaim`.

To set the trusted fields you need to include `ably.channel.*` in your JWT authentication payload, for example:

Expand Down