Uh oh!
There was an error while loading. Please reload this page.
fix(backend): Align enterprise connection create and update params with the Backend API - #9155
Merged
Merged
Conversation
…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>
…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>
🦋 Changeset detectedLatest commit: 95db01e The changes in this PR will be included in the next version bump. This PR includes changesets to release 10 packages
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 |
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (6)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
📝 WalkthroughWalkthroughEnterprise connection API types now require supported creation providers, names, and domains, and add provisioning, custom attribute, and SAML login-hint parameters. Update types add additional-identification control and deprecate changing providers. Tests cover compile-time constraints, provider payloads, and camelCase-to-snake_case serialization. The integration helper now passes typed parameters directly. Changesets document the backend patch release. Estimated code review effort: 3 (Moderate) | ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
9 tasks
…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>
Adds the optional create/update params the Backend API supports but the SDK types omitted: allowOrganizationAccountLinking, customAttributes, authenticatable, disableJitProvisioning, disableAdditionalIdentifications (update only), and saml.loginHint. Verified against BAPI's CreateParams/UpdateParams/SAMLParams in clerk_go. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotnyforce-pushed
the
manovotny/amazing-lalande-e031c2
branch
from
July 14, 2026 04:26
ace6b49 to
7b6b5c0CompareCodex review: BAPI requires login_hint.source exactly when mode is custom_attribute and rejects it otherwise; model as a discriminated union. Also lock name/domains as required with type-level tests. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
changed the base branch from
manovotny/distracted-mahavira-cb3019
to
mainJuly 16, 2026 16:18
9 tasks
@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/electron@clerk/electron-passkeys@clerk/eslint-plugin@clerk/expo@clerk/expo-passkeys@clerk/express@clerk/fastify@clerk/hono@clerk/localizations@clerk/nextjs@clerk/nuxt@clerk/react@clerk/react-router@clerk/shared@clerk/tanstack-react-start@clerk/testing@clerk/ui@clerk/upgrade@clerk/vuecommit: |
Contributor
API Changes Report
Summary
No API Changes DetectedAll packages have stable APIs with no detected changes. Report generated by Break Check Last ran on |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Aligns
CreateEnterpriseConnectionParamsandUpdateEnterpriseConnectionParamswith the Backend API contract (clerk_goapi/bapi/v1/enterprise_connections/service.go). Folds in #9153 — the provider fix and this work are one thought: the create/update params didn't match what BAPI accepts. Every claim was verified against the Go source.Discovered while reviewing clerk/clerk#2887, where a docs code sample calling
createEnterpriseConnectionwithoutproviderwould fail BAPI validation despite type-checking.Required
providerfield (from #9153)CreateEnterpriseConnectionParamswas missingprovider, which BAPI validates as required. Calls without it type-checked and failed at runtime. The field is typed as theOrganizationEnterpriseConnectionProviderunion from@clerk/shared/types(matching the siblingSamlConnectionApipattern), with type-level tests so it can't silently become optional or widen back tostring.providerbehind anascast to work around the missing field. The cast is removed.Required
nameanddomains, plus deprecationsnameanddomainsare now required on create. BAPI validates both (validate:"required",min=1on domains), so calls without them already failed at runtime — the types now catch it at compile time. Type-level tests lock each field individually.syncUserAttributeson create is deprecated. BAPI'sCreateParamshas nosync_user_attributesfield; the JSON decoder drops it silently. It works on update, and the deprecation notice points there.provideron update is deprecated. BAPI'sUpdateParamshas noproviderfield — the provider can't be changed after creation.Missing optional params
allowOrganizationAccountLinking,customAttributes,authenticatable,disableJitProvisioning(create and update),disableAdditionalIdentifications(update only), andsaml.loginHint.loginHintis a discriminated union:sourceis required exactly whenmodeis'custom_attribute'and rejected otherwise, matching BAPI's validation. Custom attribute shapes (nameandkeyrequired) match the Go structs, and all camelCase names were confirmed to snake-case to the exact wire keys.Making previously-optional fields required is a compile-time change, but only for calls that already failed BAPI validation at runtime — it converts a runtime failure into a type error. Ships as a patch for that reason.
To test:
pnpm --filter @clerk/backend test:node EnterpriseConnectionApi.test.ts— wire-format tests assert every field reaches the request body in snake_case, alongside the type-level assertions.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
🤖 Generated with Claude Code