Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-badgers-kiss.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add EnterpriseAccount and EnterpriseAccountConnection classes to @clerk/backend, restoring enterprise SSO account data on the User object that was lost when samlAccounts was removed in v3.
3 changes: 3 additions & 0 deletions packages/backend/src/api/__tests__/factory.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,9 @@ describe('api.client', () => {
expect(response.emailAddresses[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.phoneNumbers[0].phoneNumber).toBe('+311-555-2368');
expect(response.externalAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].emailAddress).toBe('john.doe@clerk.test');
expect(response.enterpriseAccounts[0].provider).toBe('saml_okta');
expect(response.enterpriseAccounts[0].enterpriseConnection?.name).toBe('Okta SSO');
expect(response.publicMetadata.zodiac_sign).toBe('leo');
});

Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
Domain,
Email,
EmailAddress,
EnterpriseAccount,
EnterpriseConnection,
IdPOAuthAccessToken,
Instance,
Expand DownExpand Up@@ -154,6 +155,8 @@ function jsonToObject(item: any): any {
return Domain.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.EnterpriseAccount:
return EnterpriseAccount.fromJSON(item);
case ObjectType.Email:
return Email.fromJSON(item);
case ObjectType.IdpOAuthAccessToken:
Expand Down
158 changes: 158 additions & 0 deletions packages/backend/src/api/resources/EnterpriseAccount.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import type { EnterpriseAccountConnectionJSON, EnterpriseAccountJSON } from './JSON';
import { Verification } from './Verification';

/**
* Represents an enterprise SSO connection associated with an enterprise account.
*/
export class EnterpriseAccountConnection {
constructor(
/**
* The unique identifier for this enterprise connection.
*/
readonly id: string,
/**
* Whether the connection is currently active.
*/
readonly active: boolean,
/**
* Whether IdP-initiated SSO is allowed.
*/
readonly allowIdpInitiated: boolean,
/**
* Whether subdomains are allowed for this connection.
*/
readonly allowSubdomains: boolean,
/**
* Whether additional identifications are disabled for users authenticating via this connection.
*/
readonly disableAdditionalIdentifications: boolean,
/**
* The domain associated with this connection.
*/
readonly domain: string,
/**
* The public URL of the connection's logo, if available.
*/
readonly logoPublicUrl: string | null,
/**
* The name of the enterprise connection.
*/
readonly name: string,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* Whether user attributes are synced from the IdP.
*/
readonly syncUserAttributes: boolean,
/**
* The date when this connection was created.
*/
readonly createdAt: number,
/**
* The date when this connection was last updated.
*/
readonly updatedAt: number,
) {}

static fromJSON(data: EnterpriseAccountConnectionJSON): EnterpriseAccountConnection {
return new EnterpriseAccountConnection(
data.id,
data.active,
data.allow_idp_initiated,
data.allow_subdomains,
data.disable_additional_identifications,
data.domain,
data.logo_public_url,
data.name,
data.protocol,
data.provider,
data.sync_user_attributes,
data.created_at,
data.updated_at,
);
}
}

/**
* The Backend `EnterpriseAccount` object represents an identification obtained via enterprise SSO (SAML or OIDC).
*/
export class EnterpriseAccount {
constructor(
/**
* The unique identifier for this enterprise account.
*/
readonly id: string,
/**
* Whether this enterprise account is currently active.
*/
readonly active: boolean,
/**
* The email address associated with this enterprise account.
*/
readonly emailAddress: string,
/**
* The enterprise connection through which this account was authenticated.
*/
readonly enterpriseConnection: EnterpriseAccountConnection | null,
/**
* The user's first name as provided by the IdP.
*/
readonly firstName: string | null,
/**
* The user's last name as provided by the IdP.
*/
readonly lastName: string | null,
/**
* The SSO protocol used (e.g., `saml` or `oauth`).
*/
readonly protocol: string,
/**
* The SSO provider (e.g., `saml_custom`, `saml_okta`).
*/
readonly provider: string,
/**
* The unique ID of the user in the provider.
*/
readonly providerUserId: string | null,
/**
* Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
*/
readonly publicMetadata: Record<string, unknown>,
/**
* An object holding information on the verification of this enterprise account.
*/
readonly verification: Verification | null,
/**
* The date when the user last authenticated via this enterprise account.
*/
readonly lastAuthenticatedAt: number | null,
/**
* The ID of the enterprise connection associated with this account.
*/
readonly enterpriseConnectionId: string | null,
) {}

static fromJSON(data: EnterpriseAccountJSON): EnterpriseAccount {
return new EnterpriseAccount(
data.id,
data.active,
data.email_address,
data.enterprise_connection && EnterpriseAccountConnection.fromJSON(data.enterprise_connection),
data.first_name,
data.last_name,
data.protocol,
data.provider,
data.provider_user_id,
data.public_metadata,
data.verification && Verification.fromJSON(data.verification),
data.last_authenticated_at,
data.enterprise_connection_id,
);
}
}
33 changes: 33 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ export const ObjectType = {
Cookies: 'cookies',
Domain: 'domain',
Email: 'email',
EnterpriseAccount: 'enterprise_account',
EnterpriseConnection: 'enterprise_connection',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -194,6 +195,37 @@ export interface EmailAddressJSON extends ClerkResourceJSON {
linked_to: IdentificationLinkJSON[];
}

export interface EnterpriseAccountConnectionJSON extends ClerkResourceJSON {
active: boolean;
allow_idp_initiated: boolean;
allow_subdomains: boolean;
disable_additional_identifications: boolean;
domain: string;
logo_public_url: string | null;
name: string;
protocol: string;
provider: string;
sync_user_attributes: boolean;
created_at: number;
updated_at: number;
}

export interface EnterpriseAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.EnterpriseAccount;
active: boolean;
email_address: string;
enterprise_connection: EnterpriseAccountConnectionJSON | null;
first_name: string | null;
last_name: string | null;
protocol: string;
provider: string;
provider_user_id: string | null;
public_metadata: Record<string, unknown>;
verification: VerificationJSON | null;
last_authenticated_at: number | null;
enterprise_connection_id: string | null;
}

export interface ExternalAccountJSON extends ClerkResourceJSON {
object: typeof ObjectType.ExternalAccount;
provider: string;
Expand DownExpand Up@@ -596,6 +628,7 @@ export interface UserJSON extends ClerkResourceJSON {
web3_wallets: Web3WalletJSON[];
organization_memberships: OrganizationMembershipJSON[] | null;
external_accounts: ExternalAccountJSON[];
enterprise_accounts: EnterpriseAccountJSON[];
password_last_updated_at: number | null;
public_metadata: UserPublicMetadata;
private_metadata: UserPrivateMetadata;
Expand Down
8 changes: 7 additions & 1 deletion packages/backend/src/api/resources/User.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { EmailAddress } from './EmailAddress';
import { EnterpriseAccount } from './EnterpriseAccount';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
import type { EnterpriseAccountJSON, ExternalAccountJSON, UserJSON } from './JSON';
import { PhoneNumber } from './PhoneNumber';
import { Web3Wallet } from './Web3Wallet';

Expand DownExpand Up@@ -119,6 +120,10 @@ export class User {
* An array of all the `ExternalAccount` objects associated with the user via OAuth. **Note**: This includes both verified & unverified external accounts.
*/
readonly externalAccounts: ExternalAccount[] = [],
/**
* An array of all the `EnterpriseAccount` objects associated with the user via enterprise SSO.
*/
readonly enterpriseAccounts: EnterpriseAccount[] = [],
/**
* Date when the user was last active.
*/
Expand DownExpand Up@@ -174,6 +179,7 @@ export class User {
(data.phone_numbers || []).map(x => PhoneNumber.fromJSON(x)),
(data.web3_wallets || []).map(x => Web3Wallet.fromJSON(x)),
(data.external_accounts || []).map((x: ExternalAccountJSON) => ExternalAccount.fromJSON(x)),
(data.enterprise_accounts || []).map((x: EnterpriseAccountJSON) => EnterpriseAccount.fromJSON(x)),
data.last_active_at,
data.create_organization_enabled,
data.create_organizations_limit,
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export type { SignUpStatus } from '@clerk/shared/types';
export * from './CommercePlan';
export * from './CommerceSubscription';
export * from './CommerceSubscriptionItem';
export * from './EnterpriseAccount';
export * from './EnterpriseConnection';
export * from './ExternalAccount';
export * from './Feature';
Expand Down
38 changes: 38 additions & 0 deletions packages/backend/src/fixtures/user.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,44 @@
"updated_at": 1611948436
}
],
"enterprise_accounts": [
{
"object": "enterprise_account",
"id": "ea_okta",
"active": true,
"email_address": "john.doe@clerk.test",
"first_name": "John",
"last_name": "Doe",
"protocol": "saml",
"provider": "saml_okta",
"provider_user_id": "okta_user_123",
"public_metadata": {},
"verification": {
"status": "verified",
"strategy": "saml",
"attempts": null,
"expire_at": 1613831855
},
"last_authenticated_at": 1611948436,
"enterprise_connection_id": "ent_conn_okta",
"enterprise_connection": {
"id": "ent_conn_okta",
"object": "enterprise_account_connection",
"active": true,
"allow_idp_initiated": false,
"allow_subdomains": false,
"disable_additional_identifications": false,
"domain": "clerk.test",
"logo_public_url": null,
"name": "Okta SSO",
"protocol": "saml",
"provider": "saml_okta",
"sync_user_attributes": true,
"created_at": 1611948436,
"updated_at": 1611948436
}
}
],
"saml_accounts": [
{
"object": "saml_account",
Expand Down
Loading