Skip to content

docs(client): document ClearanceOptions.scope as reserved - #41

Merged
cport1 merged 1 commit into
mainfrom
docs/clearance-scope-option
Sep 17, 2026
Merged

cport1 merged 1 commit into
mainfrom
docs/clearance-scope-option

Conversation

@cport1

@cport1 cport1 commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

What changed

ClearanceOptions.scope (and the data-scope script attribute that feeds it) was documented as a route-group scope that limits where a clearance token is valid. No validator restricts a token by that value.

The JSDoc now says what is true:

  • scope is reserved. It is still sent with the mint request, and passing it still has no effect, so no existing page breaks.
  • A clearance token is bound to the organization. Any of its sites accepts it, subject to expiry, the fingerprint deny list and the verification level required by the path it is used on.
  • A path's verification level is the way to require stronger proof on sensitive routes.

Also adds a CHANGELOG entry under Unreleased. No runtime change.

Checks

  • tsc --noEmit for packages/client passes.

@cport1
cport1 merged commit b720810 into main Sep 17, 2026
2 checks passed
@cport1
cport1 deleted the docs/clearance-scope-option branch September 17, 2026 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant