Skip to content

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

Open
AndyTWF wants to merge 1 commit intomainfrom
claude/custom-restrictions-docs-Hzp8B
Open

[NO MERGE] Clarify user claim handling for presence and annotations#3200
AndyTWF wants to merge 1 commit intomainfrom
claude/custom-restrictions-docs-Hzp8B

Conversation

@AndyTWF
Copy link
Contributor

@AndyTWF AndyTWF commented Feb 12, 2026

Description

This PR updates the documentation for JWT user claims in Ably to include Presence and Annotations.

CHA-1243

Checklist

https://claude.ai/code/session_01TKV8vHU7MP62PNzDJuKwiF

@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch claude/custom-restrictions-docs-Hzp8B

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@AndyTWF AndyTWF force-pushed the claude/custom-restrictions-docs-Hzp8B branch from 0558b5d to 5072d7c Compare February 12, 2026 10:19
Add clarification that custom restrictions also apply to presence messages and individual annotations. The user claim is included in extras.userClaim for both cases (presence.extras.userClaim and annotation.extras.userClaim).

https://claude.ai/code/session_01TKV8vHU7MP62PNzDJuKwiF
@AndyTWF AndyTWF force-pushed the claude/custom-restrictions-docs-Hzp8B branch from 5072d7c to 17048d1 Compare February 12, 2026 10:21
@AndyTWF AndyTWF marked this pull request as draft February 12, 2026 10:23
@AndyTWF AndyTWF changed the title Clarify user claim handling for presence and annotations [NO MERGE] Clarify user claim handling for presence and annotations Feb 12, 2026
@AndyTWF AndyTWF marked this pull request as ready for review February 12, 2026 17:38
@AndyTWF
Copy link
Contributor Author

AndyTWF commented Feb 12, 2026

@ably/team-deved Not ready to merge until next week, but ready for review :)

Copy link
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small suggestion but otherwise LGTM

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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth a link to presence and annotations pages I think

@m-hulbert m-hulbert added the Do not merge When the PR is in progress do not merge label Feb 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Do not merge When the PR is in progress do not merge

Development

Successfully merging this pull request may close these issues.

3 participants