fix(backend): Add required provider field to CreateEnterpriseConnectionParams by manovotny · Pull Request #9153 · clerk/javascript

manovotny · 2026-07-14T03:55:58Z

Description

CreateEnterpriseConnectionParams was missing the provider field, but the Backend API requires it (validate:"required" on BAPI's CreateParams). Calls to createEnterpriseConnection() without it type-checked fine and then failed validation at runtime. The type now carries a required provider, typed as the OrganizationEnterpriseConnectionProvider union from @clerk/shared/types — the same narrow-union pattern SamlConnectionApi already uses — so both missing and unsupported values are caught at compile time.

Verified against the clerk_go source: provider is required on create, and the shared union exactly matches the server allowlist — saml_custom, saml_okta, saml_google, saml_microsoft, oidc_custom, oidc_github_enterprise, and oidc_gitlab.

Two side effects worth calling out:

Making the field required is a compile-time break for TypeScript callers that omit it — but those calls were already broken at runtime, so this converts a runtime failure into a type error. Shipping as a patch for that reason.
The tanstack-start enterprise SSO integration test was already passing provider behind an as cast to work around the missing field. The cast is now removed.

To test: pnpm --filter @clerk/backend test:node EnterpriseConnectionApi.test.ts — both create tests pass provider and assert it reaches the request body, and type-level assertions lock in that provider is required and rejects unsupported values.

A follow-up will align the remaining create-params gaps with the BAPI contract (name and domains are also required server-side).

Discovered while reviewing clerk/clerk#2887, where a docs code sample calling createEnterpriseConnection without provider would fail BAPI validation despite type-checking.

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Summary by CodeRabbit

Bug Fixes
- Enterprise connection creation now requires a supported provider, preventing invalid requests and related runtime failures.
- Added validation for supported SAML and OIDC provider values.
Tests
- Expanded coverage to verify provider values are included for SAML and OIDC connections.
- Added type-level checks to reject unsupported provider values.

…onParams The Backend API validates provider as required on enterprise connection creation, so calls without it type-checked but failed at runtime. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

vercel · 2026-07-14T03:56:05Z

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

Project	Deployment	Actions	Updated (UTC)
clerk-js-sandbox	Ready	Preview, Comment	Jul 14, 2026 4:12am
swingset	Ready	Preview, Comment	Jul 14, 2026 4:12am

changeset-bot · 2026-07-14T03:56:05Z

🦋 Changeset detected

Latest commit: 2092c3a

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

This PR includes changesets to release 10 packages

Name	Type
@clerk/backend	Patch
@clerk/astro	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/hono	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch

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

coderabbitai · 2026-07-14T03:56:06Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 605b9e59-ef70-41b2-ba2f-71d942cd1656

📥 Commits

Reviewing files that changed from the base of the PR and between 1de44bf and 2092c3a.

📒 Files selected for processing (4)

.changeset/heavy-melons-argue.md
integration/tests/tanstack-start/enterprise-sso.test.ts
packages/backend/src/api/__tests__/EnterpriseConnectionApi.test.ts
packages/backend/src/api/endpoints/EnterpriseConnectionApi.ts

📝 Walkthrough

Walkthrough

The enterprise connection creation parameters now require a supported provider value. SAML and OIDC API tests assert the provider payloads and type constraints, and the integration helper no longer needs a type assertion.

Changes

Enterprise connection provider

Layer / File(s)	Summary
Require provider in creation parameters `packages/backend/src/api/endpoints/EnterpriseConnectionApi.ts`, `.changeset/heavy-melons-argue.md`	`CreateEnterpriseConnectionParams` now requires an `OrganizationEnterpriseConnectionProvider` value, documented in the changeset.
Validate provider payloads and callers `packages/backend/src/api/__tests__/EnterpriseConnectionApi.test.ts`, `integration/tests/tanstack-start/enterprise-sso.test.ts`	SAML and OIDC requests include and assert explicit providers; type-level checks validate supported values, and the integration helper removes its cast.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: laurabeatris

Poem

I’m a rabbit with providers in tow,
SAML and OIDC now clearly show.
Types guard the gate,
Casts hibernate,
And enterprise connections now grow!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: adding a required provider field to CreateEnterpriseConnectionParams.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

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

pkg-pr-new · 2026-07-14T03:59:07Z

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 2092c3a

…ntract Reuses the OrganizationEnterpriseConnectionProvider union from @clerk/shared/types (matching the sibling SamlConnectionApi pattern) and adds type-level tests so provider can't silently become optional or widen back to string. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

github-actions · 2026-07-14T04:15:53Z

API Changes Report

Generated by Break Check on 2026-07-14T04:15:50.647Z

Summary

Metric	Count
Packages analyzed	19
Packages with changes	0
🔴 Breaking changes	0
🟡 Non-breaking changes	0
🟢 Additions	0

No API Changes Detected

All packages have stable APIs with no detected changes.

Report generated by Break Check

_{Last ran on 2092c3a.}

…ctions Stacked on #9153 (required provider field). Aligns the remaining CreateEnterpriseConnectionParams gaps with the Backend API contract, which validates name and domains (min 1) as required. Deprecates syncUserAttributes on create and provider on update, since the Backend API ignores both. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

fix(backend): Add required provider field to CreateEnterpriseConnecti…

1fd49b8

…onParams The Backend API validates provider as required on enterprise connection creation, so calls without it type-checked but failed at runtime. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

vercel Bot deployed to Preview – clerk-js-sandbox July 14, 2026 03:56 View deployment

github-actions Bot added backend integration labels Jul 14, 2026

vercel Bot deployed to Preview – swingset July 14, 2026 03:57 View deployment

vercel Bot deployed to Preview – clerk-js-sandbox July 14, 2026 04:10 View deployment

vercel Bot deployed to Preview – swingset July 14, 2026 04:12 View deployment

manovotny marked this pull request as ready for review July 14, 2026 04:13

manovotny mentioned this pull request Jul 14, 2026

fix(backend): Align enterprise connection create and update params with the Backend API #9155

Open

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(backend): Add required provider field to CreateEnterpriseConnectionParams#9153

fix(backend): Add required provider field to CreateEnterpriseConnectionParams#9153
manovotny wants to merge 2 commits into
mainfrom
manovotny/distracted-mahavira-cb3019

manovotny commented Jul 14, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Jul 14, 2026 •

edited

Loading

Uh oh!

changeset-bot Bot commented Jul 14, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 14, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Jul 14, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

manovotny commented Jul 14, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Summary by CodeRabbit

Uh oh!

vercel Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 14, 2026

API Changes Report

Summary

No API Changes Detected

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

manovotny commented Jul 14, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented Jul 14, 2026 •

edited

Loading

changeset-bot Bot commented Jul 14, 2026 •

edited

Loading

coderabbitai Bot commented Jul 14, 2026 •

edited

Loading

pkg-pr-new Bot commented Jul 14, 2026 •

edited

Loading