Skip to content

Conversation

@mikeCRL
Copy link
Contributor

@mikeCRL mikeCRL commented Nov 3, 2025

Fixes DOC-13052

  • NEW - v25.4/jwt-authorization.md

    • New page documenting JWT authorization for SQL clients
    • Covers automatic role synchronization based on JWT group claims from IdP
    • Includes automatic user provisioning configuration and PROVISIONSRC tagging
    • IdP-specific examples for Okta, Google, Azure AD, Keycloak
  • NEW - v25.4/oidc-authorization.md

    • New page documenting OIDC authorization for DB Console
    • Covers automatic role synchronization based on OIDC group claims from ID token, access token, or userinfo endpoint
    • Notes that automatic user provisioning not available (planned for 'future release')
  • REWRITE - v25.4/sso-sql.md

    • Rewrite intro: JWT authentication works with external IdPs (Okta, Google, Azure AD, etc.) as primary method; DB Console JWT generation (the doc's former focus) is optional convenience feature
    • Add v25.4 features intro: JWT authorization (automatic role sync) and automatic user provisioning
    • Fix prerequisites section: remove incorrect OIDC/DB Console requirement, add IdP requirement as primary prerequisite, clarify user provisioning is optional if automatic provisioning enabled
    • Update "Authenticate to your cluster" section: distinguish two JWT acquisition methods (direct from IdP APIs vs. DB Console generation)
    • Remove misplaced callout about DB Console tier availability (moved to sso-db-console.md)

Minor updates:

  • v25.4/sso-db-console.md: Add callout after prereqs: Doesn't apply to Basic/Standard; link out to cloud-sso-sql.md
  • v25.4/security-reference/authorization.md: Add "Automatic role synchronization" section documenting JWT, OIDC, LDAP authorization methods; cross-ref jwt-authorization.md, oidc-authorization.md, ldap-authorization.md
  • v25.4/security-reference/security-overview.md: Add 4 new rows to authentication table: JWT authorization, OIDC authorization, LDAP authorization, JWT user provisioning
  • v25.4/authentication.md: Enhance client authentication bullets: add mentions of authorization (automatic role sync) and user provisioning features for JWT and OIDC; cross-references to jwt-authorization.md and oidc-authorization.md

@netlify
Copy link

netlify bot commented Nov 3, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit e41494e
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69085a35e132e20008d08581

@netlify
Copy link

netlify bot commented Nov 3, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit e41494e
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69085a358bedc100085afe05

@netlify
Copy link

netlify bot commented Nov 3, 2025

Netlify Preview

Name Link
🔨 Latest commit e41494e
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69085a358730e00008ccfbf4
😎 Deploy Preview https://deploy-preview-20921--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

mikeCRL and others added 2 commits November 3, 2025 01:08
This commit addresses critical documentation issues in sso-sql.md where JWT
authentication was incorrectly presented as requiring OIDC/DB Console
configuration. JWT authentication works independently with external IdPs.

Changes to sso-sql.md:
- Rewrite intro to clarify JWT tokens come from external IdPs (primary method)
- Position DB Console JWT generation as optional convenience feature
- Add v25.4 features introduction (JWT authorization, user provisioning)
- Fix prerequisites: remove incorrect OIDC requirement, clarify user provisioning
- Update "Authenticate to your cluster" section to distinguish two JWT methods
- Remove product scope restrictions (Enterprise license no longer required)
- Remove misplaced callout about DB Console availability

Changes to sso-db-console.md:
- Add callout clarifying Basic/Standard clusters lack DB Console access
- Link to cloud-sso-sql.md for alternative authentication on those tiers

Based on evidence from:
- Engineering docs (jwtauthccl package architectural independence)
- Release history (JWT auth v22.2, DB Console generation v23.1)
- Cloud docs (cloud-sso-sql.md explicitly mentions "external IdP")
- Code analysis (no OIDC dependencies in JWT authentication)

Fixes confusion where users believed JWT authentication required DB Console
or OIDC configuration, when it actually works with any external IdP.
@mikeCRL mikeCRL marked this pull request as ready for review November 3, 2025 07:08
-- View all JWT-provisioned users
SELECT rolname, rolprovisionsrc
FROM pg_roles
WHERE rolprovisionsrc LIKE 'jwt_token:%';

Choose a reason for hiding this comment

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

Does this work? We haven't added any new columns to the pg_roles table. The existing role options table was changed to have a new option type 'PROVISIONSRC'. with value as mentioned.

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