feat(backend): Deprecate domain field in favor of domains on SAML connections/account

.changeset/lucky-spoons-wonder.md

@@ -0,0 +1,5 @@
+---
+'@clerk/backend': minor
+---
+
+Deprecates `domain` field and introduce `domains`. Now, SAML connections support multiple domains, the `domain` field still supported but it's deprecated and will be removed on a future API version.

packages/backend/src/api/endpoints/SamlConnectionApi.ts

@@ -13,7 +13,9 @@ type SamlConnectionListParams = {
 type CreateSamlConnectionParams = {
   name: string;
   provider: SamlIdpSlug;
+  /** @deprecated Use `domains` array instead. This field will be removed in a future API version.. */
   domain: string;
+  domains: string[];
   organizationId?: string;
   idpEntityId?: string;
   idpSsoUrl?: string;
@@ -31,7 +33,9 @@ type CreateSamlConnectionParams = {
 type UpdateSamlConnectionParams = {
   name?: string;
   provider?: SamlIdpSlug;
+  /** @deprecated Use `domains` array instead. This field will be removed in a future API version.. */
   domain?: string;
+  domains?: string[];
   organizationId?: string;
   idpEntityId?: string;
   idpSsoUrl?: string;

packages/backend/src/api/resources/JSON.ts

@@ -631,6 +631,7 @@ export interface SamlConnectionJSON extends ClerkResourceJSON {
   object: typeof ObjectType.SamlConnection;
   name: string;
   domain: string;
+  domains: string[];
   organization_id: string | null;
   idp_entity_id: string;
   idp_sso_url: string;
@@ -688,6 +689,7 @@ export interface SamlAccountConnectionJSON extends ClerkResourceJSON {
   id: string;
   name: string;
   domain: string;
+  domains: string[];
   active: boolean;
   provider: string;
   sync_user_attributes: boolean;

packages/backend/src/api/resources/SamlConnection.ts

@@ -14,9 +14,13 @@ export class SamlConnection {
      */
     readonly name: string,
     /**
-     * The domain of your organization. Sign in flows using an email with this domain will use the connection.
+     * @deprecated The domain of your organization. Sign in flows using an email with this domain will use the connection.
      */
     readonly domain: string,
+    /**
+     * The domains of your organization. Sign in flows using an email with one of these domains will use the connection.
+     */
+    readonly domains: string[],
     /**
      * The organization ID of the organization.
      */
@@ -95,6 +99,7 @@ export class SamlConnection {
       data.id,
       data.name,
       data.domain,
+      data.domains,
       data.organization_id,
       data.idp_entity_id,
       data.idp_sso_url,
@@ -121,7 +126,11 @@ export class SamlAccountConnection {
   constructor(
     readonly id: string,
     readonly name: string,
+    /**
+     * @deprecated Use `domains` array instead. This field will be removed in a future version.
+     */
     readonly domain: string,
+    readonly domains: string[],
     readonly active: boolean,
     readonly provider: string,
     readonly syncUserAttributes: boolean,
@@ -135,6 +144,7 @@ export class SamlAccountConnection {
       data.id,
       data.name,
       data.domain,
+      data.domains,
       data.active,
       data.provider,
       data.sync_user_attributes,