feat(ui,clerk-js,shared): Allow to link external accounts to enterprise accounts (#8091)

Co-authored-by: Laura Beatris <48022589+LauraBeatris@users.noreply.github.com>

Author: NicolasLopes7

.changeset/large-cameras-talk.md

@@ -0,0 +1,8 @@
+---
+'@clerk/localizations': minor
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Allow to link external accounts to enterprise accounts via `UserProfile`

packages/clerk-js/src/core/resources/EnterpriseAccount.ts

@@ -61,6 +61,8 @@ export class EnterpriseAccount extends BaseResource implements EnterpriseAccount
     return this;
   }
 
+  destroy = (): Promise<void> => this._baseDelete();
+
   public __internal_toSnapshot(): EnterpriseAccountJSONSnapshot {
     return {
       object: 'enterprise_account',
@@ -93,6 +95,7 @@ export class EnterpriseAccountConnection extends BaseResource implements Enterpr
   protocol!: EnterpriseAccountResource['protocol'];
   provider!: EnterpriseAccountResource['provider'];
   syncUserAttributes!: boolean;
+  allowOrganizationAccountLinking!: boolean;
   createdAt!: Date;
   updatedAt!: Date;
   enterpriseConnectionId: string | null = '';
@@ -114,6 +117,7 @@ export class EnterpriseAccountConnection extends BaseResource implements Enterpr
       this.allowSubdomains = data.allow_subdomains;
       this.allowIdpInitiated = data.allow_idp_initiated;
       this.disableAdditionalIdentifications = data.disable_additional_identifications;
+      this.allowOrganizationAccountLinking = data.allow_organization_account_linking;
       this.createdAt = unixEpochToDate(data.created_at);
       this.updatedAt = unixEpochToDate(data.updated_at);
       this.enterpriseConnectionId = data.enterprise_connection_id;
@@ -136,6 +140,7 @@ export class EnterpriseAccountConnection extends BaseResource implements Enterpr
       allow_subdomains: this.allowSubdomains,
       allow_idp_initiated: this.allowIdpInitiated,
       disable_additional_identifications: this.disableAdditionalIdentifications,
+      allow_organization_account_linking: this.allowOrganizationAccountLinking,
       enterprise_connection_id: this.enterpriseConnectionId,
       created_at: this.createdAt.getTime(),
       updated_at: this.updatedAt.getTime(),

packages/clerk-js/src/core/resources/User.ts

@@ -9,9 +9,12 @@ import type {
   DeletedObjectJSON,
   DeletedObjectResource,
   EmailAddressResource,
+  EnterpriseAccountConnectionJSON,
+  EnterpriseAccountConnectionResource,
   EnterpriseAccountResource,
   ExternalAccountJSON,
   ExternalAccountResource,
+  GetEnterpriseConnectionsParams,
   GetOrganizationMemberships,
   GetUserOrganizationInvitationsParams,
   GetUserOrganizationSuggestionsParams,
@@ -42,6 +45,7 @@ import {
   DeletedObject,
   EmailAddress,
   EnterpriseAccount,
+  EnterpriseAccountConnection,
   ExternalAccount,
   Image,
   OrganizationMembership,
@@ -156,7 +160,7 @@ export class User extends BaseResource implements UserResource {
   };
 
   createExternalAccount = async (params: CreateExternalAccountParams): Promise<ExternalAccountResource> => {
-    const { strategy, redirectUrl, additionalScopes } = params || {};
+    const { strategy, redirectUrl, additionalScopes, enterpriseConnectionId } = params || {};
 
     const json = (
       await BaseResource._fetch<ExternalAccountJSON>({
@@ -166,6 +170,7 @@ export class User extends BaseResource implements UserResource {
           strategy,
           redirect_url: redirectUrl,
           additional_scope: additionalScopes,
+          enterprise_connection_id: enterpriseConnectionId,
         } as any,
       })
     )?.response as unknown as ExternalAccountJSON;
@@ -289,6 +294,28 @@ export class User extends BaseResource implements UserResource {
     return new DeletedObject(json);
   };
 
+  getEnterpriseConnections = async (
+    params?: GetEnterpriseConnectionsParams,
+  ): Promise<EnterpriseAccountConnectionResource[]> => {
+    const { withOrganizationAccountLinking } = params || {};
+
+    const json = (
+      await BaseResource._fetch({
+        path: '/me/enterprise_connections',
+        method: 'GET',
+        ...(withOrganizationAccountLinking !== undefined
+          ? {
+              search: {
+                with_organization_account_linking: String(withOrganizationAccountLinking),
+              },
+            }
+          : {}),
+      })
+    )?.response as unknown as EnterpriseAccountConnectionJSON[];
+
+    return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+  };
+
   initializePaymentMethod: typeof initializePaymentMethod = params => {
     return initializePaymentMethod(params);
   };

packages/clerk-js/src/core/resources/__tests__/User.test.ts

@@ -42,6 +42,88 @@ describe('User', () => {
     });
   });
 
+  it('creates an external account with enterprise connection id', async () => {
+    const externalAccountJSON = {
+      object: 'external_account',
+      provider: 'saml_okta',
+      verification: {
+        external_verification_redirect_url: 'https://www.example.com',
+      },
+    };
+
+    // @ts-ignore
+    BaseResource._fetch = vi.fn().mockReturnValue(Promise.resolve({ response: externalAccountJSON }));
+
+    const user = new User({
+      email_addresses: [],
+      phone_numbers: [],
+      web3_wallets: [],
+      external_accounts: [],
+    } as unknown as UserJSON);
+
+    await user.createExternalAccount({
+      enterpriseConnectionId: 'ec_123',
+      redirectUrl: 'https://www.example.com',
+    });
+
+    // @ts-ignore
+    expect(BaseResource._fetch).toHaveBeenCalledWith({
+      method: 'POST',
+      path: '/me/external_accounts',
+      body: {
+        strategy: undefined,
+        redirect_url: 'https://www.example.com',
+        additional_scope: undefined,
+        enterprise_connection_id: 'ec_123',
+      },
+    });
+  });
+
+  it('fetches enterprise connections', async () => {
+    const enterpriseConnectionsJSON = [
+      {
+        id: 'ec_123',
+        object: 'enterprise_account_connection',
+        name: 'Acme Corp SSO',
+        active: true,
+        allow_organization_account_linking: true,
+        domain: 'acme.com',
+        protocol: 'saml',
+        provider: 'saml_okta',
+        logo_public_url: null,
+        sync_user_attributes: true,
+        allow_subdomains: false,
+        allow_idp_initiated: false,
+        disable_additional_identifications: false,
+        enterprise_connection_id: 'ec_123',
+        created_at: 1234567890,
+        updated_at: 1234567890,
+      },
+    ];
+
+    // @ts-ignore
+    BaseResource._fetch = vi.fn().mockReturnValue(Promise.resolve({ response: enterpriseConnectionsJSON }));
+
+    const user = new User({
+      email_addresses: [],
+      phone_numbers: [],
+      web3_wallets: [],
+      external_accounts: [],
+    } as unknown as UserJSON);
+
+    const connections = await user.getEnterpriseConnections();
+
+    // @ts-ignore
+    expect(BaseResource._fetch).toHaveBeenCalledWith({
+      method: 'GET',
+      path: '/me/enterprise_connections',
+    });
+
+    expect(connections).toHaveLength(1);
+    expect(connections[0].name).toBe('Acme Corp SSO');
+    expect(connections[0].allowOrganizationAccountLinking).toBe(true);
+  });
+
   it('creates a web3 wallet', async () => {
     const targetWeb3Wallet = '0x0000000000000000000000000000000000000000';
     const web3WalletJSON = {

packages/localizations/src/ar-SA.ts

@@ -1338,6 +1338,7 @@ export const arSA: LocalizationResource = {
         title: 'العنوان الإلكتروني',
       },
       enterpriseAccountsSection: {
+        primaryButton: 'ربط حساب',
         title: 'حساب المؤسسات',
       },
       headerTitle__account: 'الحساب',

packages/localizations/src/be-BY.ts

@@ -1357,6 +1357,7 @@ export const beBY: LocalizationResource = {
         title: 'Адрасы электроннай пошты',
       },
       enterpriseAccountsSection: {
+        primaryButton: 'Падключыць уліковы запіс',
         title: 'Enterprise accounts',
       },
       headerTitle__account: 'Уліковы запіс',

packages/localizations/src/bg-BG.ts

@@ -1348,6 +1348,7 @@ export const bgBG: LocalizationResource = {
         title: 'Имейл адреси',
       },
       enterpriseAccountsSection: {
+        primaryButton: 'Свържи акаунт',
         title: 'Корпоративни акаунти',
       },
       headerTitle__account: 'Профил',

packages/localizations/src/bn-IN.ts

@@ -1359,6 +1359,7 @@ export const bnIN: LocalizationResource = {
         title: 'ইমেইল ঠিকানা',
       },
       enterpriseAccountsSection: {
+        primaryButton: 'অ্যাকাউন্ট সংযুক্ত করুন',
         title: 'এন্টারপ্রাইজ অ্যাকাউন্ট',
       },
       headerTitle__account: 'প্রোফাইল বিবরণ',

packages/localizations/src/ca-ES.ts

@@ -1354,6 +1354,7 @@ export const caES: LocalizationResource = {
         title: 'Adreces de correu electrònic',
       },
       enterpriseAccountsSection: {
+        primaryButton: 'Connecta compte',
         title: "Comptes d'empresa",
       },
       headerTitle__account: 'Detalls del perfil',

packages/localizations/src/cs-CZ.ts

@@ -1361,6 +1361,7 @@ export const csCZ: LocalizationResource = {
         title: 'E-mailové adresy',
       },
       enterpriseAccountsSection: {
+        primaryButton: 'Připojit účet',
         title: 'Podnikové účty',
       },
       headerTitle__account: 'Podrobnosti profilu',