Skip to content

docs(shared): document SSOBypassAllowlistResource - #9979

Draft
SarahSoutoul wants to merge 4 commits into
mainfrom
ss/DOCS-12221
Draft

SarahSoutoul wants to merge 4 commits into
mainfrom
ss/DOCS-12221

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Description

DOCS-12221

Document SSOBypassAllowlistResource and its four methods in JSDoc. The resource description links only Organization to its reference page and explains the required org:sys_entconns_sso_bypass:manage System Permission. Method descriptions cover parameters and return values, including the partial-success behavior of addUsers().

Add the TypeDoc link mapping so the generated OrganizationResource.ssoBypassAllowlist property points to /docs/reference/types/sso-bypass-allowlist-resource. The type page itself is hand-authored in clerk/clerk, following its type-reference convention. It is prepared locally for a separate docs PR now that clerk/clerk#3455 has merged; that page should land before the next TypeDoc refresh publishes the link. This documentation-only PR has an empty changeset.

Checklist

  • JSDoc comments have been added or updated for package exports
  • Companion type page in clerk/clerk (prepared locally for a separate PR)

Type of change

  • 📖 Documentation

@vercel

vercel Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
clerk-js-sandbox Ready Ready Preview Sep 29, 2026 9:11pm UTC
swingset Ready Ready Preview Sep 29, 2026 9:11pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

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

@changeset-bot

changeset-bot Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 7e05218

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@pkg-pr-new

pkg-pr-new Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@9979

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@9979

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@9979

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@9979

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9979

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9979

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9979

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@9979

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9979

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@9979

@clerk/express

npm i https://pkg.pr.new/@clerk/express@9979

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@9979

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@9979

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@9979

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@9979

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@9979

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@9979

@clerk/react

npm i https://pkg.pr.new/@clerk/react@9979

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@9979

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@9979

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@9979

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@9979

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@9979

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@9979

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@9979

commit: 7e05218

@SarahSoutoul SarahSoutoul changed the title docs(shared): document SSOBypassAllowlistResource (DOCS-12221) docs(shared): document SSOBypassAllowlistResource Sep 29, 2026
@SarahSoutoul SarahSoutoul changed the title docs(shared): document SSOBypassAllowlistResource docs(shared): document SSOBypassAllowlistResource Sep 29, 2026

This branch was successfully deployed

2 active deployments
Preview – swingset — 7e05218e Deployed Sep 29, 2026 by vercel[bot]
Preview – clerk-js-sandbox — 7e05218e Deployed Sep 29, 2026 by vercel[bot]
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.

2 participants