fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmilewski merged 2 commits into from
Jul 28, 2025
+180 −37
Merged

fix(backend): Ability to convert bodyParam keys recursively #6418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80f1011
fix: Ability to convert bodyParam keys recursively
tmilewski Jul 28, 2025
5c3bb73
chore: Add changeset
tmilewski Jul 28, 2025
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/silver-singers-train.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.
165 changes: 138 additions & 27 deletions packages/backend/src/api/__tests__/SamlConnectionApi.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
secretKey: 'deadbeef',
});

const mockSamlConnectionResponse = {
object: 'saml_connection',
id: 'samlc_123',
name: 'Test Connection',
provider: 'saml_custom',
domain: 'test.example.com',
organization_id: 'org_123',
created_at: 1672531200000,
updated_at: 1672531200000,
active: true,
sync_user_attributes: false,
allow_subdomains: false,
allow_idp_initiated: false,
idp_entity_id: 'entity_123',
idp_sso_url: 'https://idp.example.com/sso',
idp_certificate: 'cert_data',
idp_metadata_url: null,
idp_metadata: null,
attribute_mapping: {
user_id: 'userId',
email_address: 'email',
first_name: 'firstName',
last_name: 'lastName',
},
};

describe('getSamlConnectionList', () => {
it('successfully fetches SAML connections with all parameters', async () => {
const mockSamlConnectionsResponse = {
data: [
{
object: 'saml_connection',
id: 'samlc_123',
name: 'Test Connection',
provider: 'saml_custom',
domain: 'test.example.com',
organization_id: 'org_123',
created_at: 1672531200000,
updated_at: 1672531200000,
active: true,
sync_user_attributes: false,
allow_subdomains: false,
allow_idp_initiated: false,
idp_entity_id: 'entity_123',
idp_sso_url: 'https://idp.example.com/sso',
idp_certificate: 'cert_data',
idp_metadata_url: null,
idp_metadata: null,
attribute_mapping: {
user_id: 'userId',
email_address: 'email',
first_name: 'firstName',
last_name: 'lastName',
},
},
],
data: [mockSamlConnectionResponse],
total_count: 1,
};

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
expect(response.totalCount).toBe(1);
});
});

describe('createSamlConnection', () => {
it('successfully creates a SAML connection', async () => {
server.use(
http.post(
'https://api.clerk.test/v1/saml_connections',
validateHeaders(async ({ request }) => {
const body = await request.json();

expect(body).toEqual({
name: 'Test Connection',
provider: 'saml_custom',
domain: 'test.example.com',
attribute_mapping: {
user_id: 'userId',
email_address: 'email',
first_name: 'firstName',
last_name: 'lastName',
},
});

return HttpResponse.json(mockSamlConnectionResponse);
}),
),
);

const response = await apiClient.samlConnections.createSamlConnection({
name: 'Test Connection',
provider: 'saml_custom',
domain: 'test.example.com',
attributeMapping: {
userId: 'userId',
emailAddress: 'email',
firstName: 'firstName',
lastName: 'lastName',
},
});

expect(response.id).toBe('samlc_123');
expect(response.name).toBe('Test Connection');
expect(response.organizationId).toBe('org_123');
});
});

describe('updateSamlConnection', () => {
it('successfully updates a SAML connection', async () => {
server.use(
http.patch(
'https://api.clerk.test/v1/saml_connections/samlc_123',
validateHeaders(async ({ request }) => {
const body = await request.json();

expect(body).toEqual({
name: 'Test Connection',
provider: 'saml_custom',
domain: 'test.example.com',
organization_id: 'org_123',
idp_entity_id: 'entity_123',
idp_sso_url: 'https://idp.example.com/sso',
idp_certificate: 'cert_data',
attribute_mapping: {
user_id: 'userId2',
email_address: 'email2',
first_name: 'firstName2',
last_name: 'lastName2',
},
});

return HttpResponse.json({
...mockSamlConnectionResponse,
idp_entity_id: 'entity_123',
idp_sso_url: 'https://idp.example.com/sso',
idp_certificate: 'cert_data',
attribute_mapping: {
user_id: 'userId2',
email_address: 'email2',
first_name: 'firstName2',
last_name: 'lastName2',
},
});
}),
),
);

const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
name: 'Test Connection',
provider: 'saml_custom',
domain: 'test.example.com',
organizationId: 'org_123',
idpEntityId: 'entity_123',
idpSsoUrl: 'https://idp.example.com/sso',
idpCertificate: 'cert_data',
attributeMapping: {
userId: 'userId2',
emailAddress: 'email2',
firstName: 'firstName2',
lastName: 'lastName2',
},
});

expect(response.id).toBe('samlc_123');
expect(response.name).toBe('Test Connection');
expect(response.organizationId).toBe('org_123');
expect(response.attributeMapping).toEqual({
userId: 'userId2',
emailAddress: 'email2',
firstName: 'firstName2',
lastName: 'lastName2',
});
});
});
});
6 changes: 6 additions & 0 deletions packages/backend/src/api/endpoints/SamlConnectionApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
method: 'POST',
path: basePath,
bodyParams: params,
options: {
deepSnakecaseBodyParamKeys: true,
},
});
}

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
method: 'PATCH',
path: joinPaths(basePath, samlConnectionId),
bodyParams: params,
options: {
deepSnakecaseBodyParamKeys: true,
},
Comment on lines +106 to +108

@wobsorianowobsorianoJul 28, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229

});
}
public async deleteSamlConnection(samlConnectionId: string) {
Expand Down
41 changes: 31 additions & 10 deletions packages/backend/src/api/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
queryParams?: Record<string, unknown>;
headerParams?: Record<string, string>;
bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
| {
url: string;
path?: string;
}
| {
url?: string;
path: string;
};

type ClerkBackendApiRequestOptionsBodyParams =
| {
bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
options?: {
/**
* If true, snakecases the keys of the bodyParams object recursively.
* @default false
*/
deepSnakecaseBodyParamKeys?: boolean;
};
}
);
| {
bodyParams?: never;
options?: {
deepSnakecaseBodyParamKeys?: never;
};
};

export type ClerkBackendApiRequestOptions = {
method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
queryParams?: Record<string, unknown>;
headerParams?: Record<string, string>;
formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
| {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
userAgent = USER_AGENT,
skipApiVersionInUrl = false,
} = options;
const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
const { deepSnakecaseBodyParamKeys = false } = opts || {};

if (requireSecretKey) {
assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
return null;
}

const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

return {
body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
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
fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tmilewski
merged 2 commits into

from

Jul 28, 2025

+180

−37

 Merged


fix(backend): Ability to convert bodyParam keys recursively
#6418
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
80f1011

fix: Ability to convert bodyParam keys recursively


tmilewski Jul 28, 2025
5c3bb73

chore: Add changeset


tmilewski Jul 28, 2025

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/silver-singers-train.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.

165 changes: 138 additions & 27 deletions
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
 secretKey: 'deadbeef',
 });

 const mockSamlConnectionResponse = {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 };

 describe('getSamlConnectionList', () => {
 it('successfully fetches SAML connections with all parameters', async () => {
 const mockSamlConnectionsResponse = {
 data: [
 {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 },
 ],
 data: [mockSamlConnectionResponse],
 total_count: 1,
 };

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
 expect(response.totalCount).toBe(1);
 });
 });

 describe('createSamlConnection', () => {
 it('successfully creates a SAML connection', async () => {
 server.use(
 http.post(
 'https://api.clerk.test/v1/saml_connections',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 });

 return HttpResponse.json(mockSamlConnectionResponse);
 }),
 ),
 );

 const response = await apiClient.samlConnections.createSamlConnection({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attributeMapping: {
 userId: 'userId',
 emailAddress: 'email',
 firstName: 'firstName',
 lastName: 'lastName',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 });
 });

 describe('updateSamlConnection', () => {
 it('successfully updates a SAML connection', async () => {
 server.use(
 http.patch(
 'https://api.clerk.test/v1/saml_connections/samlc_123',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });

 return HttpResponse.json({
 ...mockSamlConnectionResponse,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });
 }),
 ),
 );

 const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organizationId: 'org_123',
 idpEntityId: 'entity_123',
 idpSsoUrl: 'https://idp.example.com/sso',
 idpCertificate: 'cert_data',
 attributeMapping: {
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 expect(response.attributeMapping).toEqual({
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 });
 });
 });
});

6 changes: 6 additions & 0 deletions
packages/backend/src/api/endpoints/SamlConnectionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'POST',
 path: basePath,
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },
 });
 }

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'PATCH',
 path: joinPaths(basePath, samlConnectionId),
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },

Comment on lines

+106
 to 
+108

@wobsorianowobsorianoJul 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229
 });
 }
 public async deleteSamlConnection(samlConnectionId: string) {
Expand Down

41 changes: 31 additions & 10 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
 formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
 | {
 url: string;
 path?: string;
 }
 | {
 url?: string;
 path: string;
 };

type ClerkBackendApiRequestOptionsBodyParams =
 | {
 bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
 options?: {
 /**
 * If true, snakecases the keys of the bodyParams object recursively.
 * @default false
 */
 deepSnakecaseBodyParamKeys?: boolean;
 };
 }
);
 | {
 bodyParams?: never;
 options?: {
 deepSnakecaseBodyParamKeys?: never;
 };
 };

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
 ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
 | {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
 userAgent = USER_AGENT,
 skipApiVersionInUrl = false,
 } = options;
 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
 const { deepSnakecaseBodyParamKeys = false } = opts || {};

 if (requireSecretKey) {
 assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
 return null;
 }

 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
 snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

 return {
 body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
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
fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tmilewski
merged 2 commits into

from

Jul 28, 2025

+180

−37

 Merged


fix(backend): Ability to convert bodyParam keys recursively
#6418
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
80f1011

fix: Ability to convert bodyParam keys recursively


tmilewski Jul 28, 2025
5c3bb73

chore: Add changeset


tmilewski Jul 28, 2025

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/silver-singers-train.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.

165 changes: 138 additions & 27 deletions
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
 secretKey: 'deadbeef',
 });

 const mockSamlConnectionResponse = {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 };

 describe('getSamlConnectionList', () => {
 it('successfully fetches SAML connections with all parameters', async () => {
 const mockSamlConnectionsResponse = {
 data: [
 {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 },
 ],
 data: [mockSamlConnectionResponse],
 total_count: 1,
 };

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
 expect(response.totalCount).toBe(1);
 });
 });

 describe('createSamlConnection', () => {
 it('successfully creates a SAML connection', async () => {
 server.use(
 http.post(
 'https://api.clerk.test/v1/saml_connections',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 });

 return HttpResponse.json(mockSamlConnectionResponse);
 }),
 ),
 );

 const response = await apiClient.samlConnections.createSamlConnection({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attributeMapping: {
 userId: 'userId',
 emailAddress: 'email',
 firstName: 'firstName',
 lastName: 'lastName',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 });
 });

 describe('updateSamlConnection', () => {
 it('successfully updates a SAML connection', async () => {
 server.use(
 http.patch(
 'https://api.clerk.test/v1/saml_connections/samlc_123',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });

 return HttpResponse.json({
 ...mockSamlConnectionResponse,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });
 }),
 ),
 );

 const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organizationId: 'org_123',
 idpEntityId: 'entity_123',
 idpSsoUrl: 'https://idp.example.com/sso',
 idpCertificate: 'cert_data',
 attributeMapping: {
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 expect(response.attributeMapping).toEqual({
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 });
 });
 });
});

6 changes: 6 additions & 0 deletions
packages/backend/src/api/endpoints/SamlConnectionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'POST',
 path: basePath,
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },
 });
 }

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'PATCH',
 path: joinPaths(basePath, samlConnectionId),
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },

Comment on lines

+106
 to 
+108

@wobsorianowobsorianoJul 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229
 });
 }
 public async deleteSamlConnection(samlConnectionId: string) {
Expand Down

41 changes: 31 additions & 10 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
 formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
 | {
 url: string;
 path?: string;
 }
 | {
 url?: string;
 path: string;
 };

type ClerkBackendApiRequestOptionsBodyParams =
 | {
 bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
 options?: {
 /**
 * If true, snakecases the keys of the bodyParams object recursively.
 * @default false
 */
 deepSnakecaseBodyParamKeys?: boolean;
 };
 }
);
 | {
 bodyParams?: never;
 options?: {
 deepSnakecaseBodyParamKeys?: never;
 };
 };

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
 ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
 | {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
 userAgent = USER_AGENT,
 skipApiVersionInUrl = false,
 } = options;
 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
 const { deepSnakecaseBodyParamKeys = false } = opts || {};

 if (requireSecretKey) {
 assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
 return null;
 }

 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
 snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

 return {
 body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
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
fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tmilewski
merged 2 commits into

from

Jul 28, 2025

+180

−37

 Merged


fix(backend): Ability to convert bodyParam keys recursively
#6418
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
80f1011

fix: Ability to convert bodyParam keys recursively


tmilewski Jul 28, 2025
5c3bb73

chore: Add changeset


tmilewski Jul 28, 2025

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/silver-singers-train.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.

165 changes: 138 additions & 27 deletions
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
 secretKey: 'deadbeef',
 });

 const mockSamlConnectionResponse = {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 };

 describe('getSamlConnectionList', () => {
 it('successfully fetches SAML connections with all parameters', async () => {
 const mockSamlConnectionsResponse = {
 data: [
 {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 },
 ],
 data: [mockSamlConnectionResponse],
 total_count: 1,
 };

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
 expect(response.totalCount).toBe(1);
 });
 });

 describe('createSamlConnection', () => {
 it('successfully creates a SAML connection', async () => {
 server.use(
 http.post(
 'https://api.clerk.test/v1/saml_connections',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 });

 return HttpResponse.json(mockSamlConnectionResponse);
 }),
 ),
 );

 const response = await apiClient.samlConnections.createSamlConnection({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attributeMapping: {
 userId: 'userId',
 emailAddress: 'email',
 firstName: 'firstName',
 lastName: 'lastName',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 });
 });

 describe('updateSamlConnection', () => {
 it('successfully updates a SAML connection', async () => {
 server.use(
 http.patch(
 'https://api.clerk.test/v1/saml_connections/samlc_123',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });

 return HttpResponse.json({
 ...mockSamlConnectionResponse,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });
 }),
 ),
 );

 const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organizationId: 'org_123',
 idpEntityId: 'entity_123',
 idpSsoUrl: 'https://idp.example.com/sso',
 idpCertificate: 'cert_data',
 attributeMapping: {
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 expect(response.attributeMapping).toEqual({
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 });
 });
 });
});

6 changes: 6 additions & 0 deletions
packages/backend/src/api/endpoints/SamlConnectionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'POST',
 path: basePath,
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },
 });
 }

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'PATCH',
 path: joinPaths(basePath, samlConnectionId),
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },

Comment on lines

+106
 to 
+108

@wobsorianowobsorianoJul 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229
 });
 }
 public async deleteSamlConnection(samlConnectionId: string) {
Expand Down

41 changes: 31 additions & 10 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
 formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
 | {
 url: string;
 path?: string;
 }
 | {
 url?: string;
 path: string;
 };

type ClerkBackendApiRequestOptionsBodyParams =
 | {
 bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
 options?: {
 /**
 * If true, snakecases the keys of the bodyParams object recursively.
 * @default false
 */
 deepSnakecaseBodyParamKeys?: boolean;
 };
 }
);
 | {
 bodyParams?: never;
 options?: {
 deepSnakecaseBodyParamKeys?: never;
 };
 };

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
 ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
 | {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
 userAgent = USER_AGENT,
 skipApiVersionInUrl = false,
 } = options;
 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
 const { deepSnakecaseBodyParamKeys = false } = opts || {};

 if (requireSecretKey) {
 assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
 return null;
 }

 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
 snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

 return {
 body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
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
fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tmilewski
merged 2 commits into

from

Jul 28, 2025

+180

−37

 Merged


fix(backend): Ability to convert bodyParam keys recursively
#6418
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
80f1011

fix: Ability to convert bodyParam keys recursively


tmilewski Jul 28, 2025
5c3bb73

chore: Add changeset


tmilewski Jul 28, 2025

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/silver-singers-train.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.

165 changes: 138 additions & 27 deletions
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
 secretKey: 'deadbeef',
 });

 const mockSamlConnectionResponse = {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 };

 describe('getSamlConnectionList', () => {
 it('successfully fetches SAML connections with all parameters', async () => {
 const mockSamlConnectionsResponse = {
 data: [
 {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 },
 ],
 data: [mockSamlConnectionResponse],
 total_count: 1,
 };

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
 expect(response.totalCount).toBe(1);
 });
 });

 describe('createSamlConnection', () => {
 it('successfully creates a SAML connection', async () => {
 server.use(
 http.post(
 'https://api.clerk.test/v1/saml_connections',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 });

 return HttpResponse.json(mockSamlConnectionResponse);
 }),
 ),
 );

 const response = await apiClient.samlConnections.createSamlConnection({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attributeMapping: {
 userId: 'userId',
 emailAddress: 'email',
 firstName: 'firstName',
 lastName: 'lastName',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 });
 });

 describe('updateSamlConnection', () => {
 it('successfully updates a SAML connection', async () => {
 server.use(
 http.patch(
 'https://api.clerk.test/v1/saml_connections/samlc_123',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });

 return HttpResponse.json({
 ...mockSamlConnectionResponse,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });
 }),
 ),
 );

 const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organizationId: 'org_123',
 idpEntityId: 'entity_123',
 idpSsoUrl: 'https://idp.example.com/sso',
 idpCertificate: 'cert_data',
 attributeMapping: {
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 expect(response.attributeMapping).toEqual({
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 });
 });
 });
});

6 changes: 6 additions & 0 deletions
packages/backend/src/api/endpoints/SamlConnectionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'POST',
 path: basePath,
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },
 });
 }

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'PATCH',
 path: joinPaths(basePath, samlConnectionId),
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },

Comment on lines

+106
 to 
+108

@wobsorianowobsorianoJul 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229
 });
 }
 public async deleteSamlConnection(samlConnectionId: string) {
Expand Down

41 changes: 31 additions & 10 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
 formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
 | {
 url: string;
 path?: string;
 }
 | {
 url?: string;
 path: string;
 };

type ClerkBackendApiRequestOptionsBodyParams =
 | {
 bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
 options?: {
 /**
 * If true, snakecases the keys of the bodyParams object recursively.
 * @default false
 */
 deepSnakecaseBodyParamKeys?: boolean;
 };
 }
);
 | {
 bodyParams?: never;
 options?: {
 deepSnakecaseBodyParamKeys?: never;
 };
 };

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
 ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
 | {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
 userAgent = USER_AGENT,
 skipApiVersionInUrl = false,
 } = options;
 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
 const { deepSnakecaseBodyParamKeys = false } = opts || {};

 if (requireSecretKey) {
 assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
 return null;
 }

 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
 snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

 return {
 body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
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
fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tmilewski
merged 2 commits into

from

Jul 28, 2025

+180

−37

 Merged


fix(backend): Ability to convert bodyParam keys recursively
#6418
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
80f1011

fix: Ability to convert bodyParam keys recursively


tmilewski Jul 28, 2025
5c3bb73

chore: Add changeset


tmilewski Jul 28, 2025

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/silver-singers-train.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.

165 changes: 138 additions & 27 deletions
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
 secretKey: 'deadbeef',
 });

 const mockSamlConnectionResponse = {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 };

 describe('getSamlConnectionList', () => {
 it('successfully fetches SAML connections with all parameters', async () => {
 const mockSamlConnectionsResponse = {
 data: [
 {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 },
 ],
 data: [mockSamlConnectionResponse],
 total_count: 1,
 };

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
 expect(response.totalCount).toBe(1);
 });
 });

 describe('createSamlConnection', () => {
 it('successfully creates a SAML connection', async () => {
 server.use(
 http.post(
 'https://api.clerk.test/v1/saml_connections',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 });

 return HttpResponse.json(mockSamlConnectionResponse);
 }),
 ),
 );

 const response = await apiClient.samlConnections.createSamlConnection({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attributeMapping: {
 userId: 'userId',
 emailAddress: 'email',
 firstName: 'firstName',
 lastName: 'lastName',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 });
 });

 describe('updateSamlConnection', () => {
 it('successfully updates a SAML connection', async () => {
 server.use(
 http.patch(
 'https://api.clerk.test/v1/saml_connections/samlc_123',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });

 return HttpResponse.json({
 ...mockSamlConnectionResponse,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });
 }),
 ),
 );

 const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organizationId: 'org_123',
 idpEntityId: 'entity_123',
 idpSsoUrl: 'https://idp.example.com/sso',
 idpCertificate: 'cert_data',
 attributeMapping: {
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 expect(response.attributeMapping).toEqual({
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 });
 });
 });
});

6 changes: 6 additions & 0 deletions
packages/backend/src/api/endpoints/SamlConnectionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'POST',
 path: basePath,
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },
 });
 }

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'PATCH',
 path: joinPaths(basePath, samlConnectionId),
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },

Comment on lines

+106
 to 
+108

@wobsorianowobsorianoJul 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229
 });
 }
 public async deleteSamlConnection(samlConnectionId: string) {
Expand Down

41 changes: 31 additions & 10 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
 formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
 | {
 url: string;
 path?: string;
 }
 | {
 url?: string;
 path: string;
 };

type ClerkBackendApiRequestOptionsBodyParams =
 | {
 bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
 options?: {
 /**
 * If true, snakecases the keys of the bodyParams object recursively.
 * @default false
 */
 deepSnakecaseBodyParamKeys?: boolean;
 };
 }
);
 | {
 bodyParams?: never;
 options?: {
 deepSnakecaseBodyParamKeys?: never;
 };
 };

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
 ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
 | {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
 userAgent = USER_AGENT,
 skipApiVersionInUrl = false,
 } = options;
 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
 const { deepSnakecaseBodyParamKeys = false } = opts || {};

 if (requireSecretKey) {
 assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
 return null;
 }

 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
 snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

 return {
 body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
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
fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tmilewski
merged 2 commits into

from

Jul 28, 2025

+180

−37

 Merged


fix(backend): Ability to convert bodyParam keys recursively
#6418
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
80f1011

fix: Ability to convert bodyParam keys recursively


tmilewski Jul 28, 2025
5c3bb73

chore: Add changeset


tmilewski Jul 28, 2025

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/silver-singers-train.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.

165 changes: 138 additions & 27 deletions
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
 secretKey: 'deadbeef',
 });

 const mockSamlConnectionResponse = {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 };

 describe('getSamlConnectionList', () => {
 it('successfully fetches SAML connections with all parameters', async () => {
 const mockSamlConnectionsResponse = {
 data: [
 {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 },
 ],
 data: [mockSamlConnectionResponse],
 total_count: 1,
 };

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
 expect(response.totalCount).toBe(1);
 });
 });

 describe('createSamlConnection', () => {
 it('successfully creates a SAML connection', async () => {
 server.use(
 http.post(
 'https://api.clerk.test/v1/saml_connections',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 });

 return HttpResponse.json(mockSamlConnectionResponse);
 }),
 ),
 );

 const response = await apiClient.samlConnections.createSamlConnection({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attributeMapping: {
 userId: 'userId',
 emailAddress: 'email',
 firstName: 'firstName',
 lastName: 'lastName',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 });
 });

 describe('updateSamlConnection', () => {
 it('successfully updates a SAML connection', async () => {
 server.use(
 http.patch(
 'https://api.clerk.test/v1/saml_connections/samlc_123',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });

 return HttpResponse.json({
 ...mockSamlConnectionResponse,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });
 }),
 ),
 );

 const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organizationId: 'org_123',
 idpEntityId: 'entity_123',
 idpSsoUrl: 'https://idp.example.com/sso',
 idpCertificate: 'cert_data',
 attributeMapping: {
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 expect(response.attributeMapping).toEqual({
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 });
 });
 });
});

6 changes: 6 additions & 0 deletions
packages/backend/src/api/endpoints/SamlConnectionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'POST',
 path: basePath,
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },
 });
 }

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'PATCH',
 path: joinPaths(basePath, samlConnectionId),
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },

Comment on lines

+106
 to 
+108

@wobsorianowobsorianoJul 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229
 });
 }
 public async deleteSamlConnection(samlConnectionId: string) {
Expand Down

41 changes: 31 additions & 10 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
 formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
 | {
 url: string;
 path?: string;
 }
 | {
 url?: string;
 path: string;
 };

type ClerkBackendApiRequestOptionsBodyParams =
 | {
 bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
 options?: {
 /**
 * If true, snakecases the keys of the bodyParams object recursively.
 * @default false
 */
 deepSnakecaseBodyParamKeys?: boolean;
 };
 }
);
 | {
 bodyParams?: never;
 options?: {
 deepSnakecaseBodyParamKeys?: never;
 };
 };

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
 ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
 | {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
 userAgent = USER_AGENT,
 skipApiVersionInUrl = false,
 } = options;
 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
 const { deepSnakecaseBodyParamKeys = false } = opts || {};

 if (requireSecretKey) {
 assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
 return null;
 }

 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
 snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

 return {
 body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
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
fix(backend): Ability to convert bodyParam keys recursively#6418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tmilewski
merged 2 commits into

from

Jul 28, 2025

+180

−37

 Merged


fix(backend): Ability to convert bodyParam keys recursively
#6418
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
80f1011

fix: Ability to convert bodyParam keys recursively


tmilewski Jul 28, 2025
5c3bb73

chore: Add changeset


tmilewski Jul 28, 2025

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/silver-singers-train.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Fix SAML Connection `attributeMapping` keys not being converted from camelCase to snake_case.

165 changes: 138 additions & 27 deletions
packages/backend/src/api/__tests__/SamlConnectionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,36 +10,36 @@ describe('SamlConnectionAPI', () => {
 secretKey: 'deadbeef',
 });

 const mockSamlConnectionResponse = {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 };

 describe('getSamlConnectionList', () => {
 it('successfully fetches SAML connections with all parameters', async () => {
 const mockSamlConnectionsResponse = {
 data: [
 {
 object: 'saml_connection',
 id: 'samlc_123',
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 created_at: 1672531200000,
 updated_at: 1672531200000,
 active: true,
 sync_user_attributes: false,
 allow_subdomains: false,
 allow_idp_initiated: false,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 idp_metadata_url: null,
 idp_metadata: null,
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 },
 ],
 data: [mockSamlConnectionResponse],
 total_count: 1,
 };

Expand DownExpand Up@@ -73,4 +73,115 @@ describe('SamlConnectionAPI', () => {
 expect(response.totalCount).toBe(1);
 });
 });

 describe('createSamlConnection', () => {
 it('successfully creates a SAML connection', async () => {
 server.use(
 http.post(
 'https://api.clerk.test/v1/saml_connections',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attribute_mapping: {
 user_id: 'userId',
 email_address: 'email',
 first_name: 'firstName',
 last_name: 'lastName',
 },
 });

 return HttpResponse.json(mockSamlConnectionResponse);
 }),
 ),
 );

 const response = await apiClient.samlConnections.createSamlConnection({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 attributeMapping: {
 userId: 'userId',
 emailAddress: 'email',
 firstName: 'firstName',
 lastName: 'lastName',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 });
 });

 describe('updateSamlConnection', () => {
 it('successfully updates a SAML connection', async () => {
 server.use(
 http.patch(
 'https://api.clerk.test/v1/saml_connections/samlc_123',
 validateHeaders(async ({ request }) => {
 const body = await request.json();

 expect(body).toEqual({
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organization_id: 'org_123',
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });

 return HttpResponse.json({
 ...mockSamlConnectionResponse,
 idp_entity_id: 'entity_123',
 idp_sso_url: 'https://idp.example.com/sso',
 idp_certificate: 'cert_data',
 attribute_mapping: {
 user_id: 'userId2',
 email_address: 'email2',
 first_name: 'firstName2',
 last_name: 'lastName2',
 },
 });
 }),
 ),
 );

 const response = await apiClient.samlConnections.updateSamlConnection('samlc_123', {
 name: 'Test Connection',
 provider: 'saml_custom',
 domain: 'test.example.com',
 organizationId: 'org_123',
 idpEntityId: 'entity_123',
 idpSsoUrl: 'https://idp.example.com/sso',
 idpCertificate: 'cert_data',
 attributeMapping: {
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 },
 });

 expect(response.id).toBe('samlc_123');
 expect(response.name).toBe('Test Connection');
 expect(response.organizationId).toBe('org_123');
 expect(response.attributeMapping).toEqual({
 userId: 'userId2',
 emailAddress: 'email2',
 firstName: 'firstName2',
 lastName: 'lastName2',
 });
 });
 });
});

6 changes: 6 additions & 0 deletions
packages/backend/src/api/endpoints/SamlConnectionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'POST',
 path: basePath,
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },
 });
 }

Expand All@@ -100,6 +103,9 @@ export class SamlConnectionAPI extends AbstractAPI {
 method: 'PATCH',
 path: joinPaths(basePath, samlConnectionId),
 bodyParams: params,
 options: {
 deepSnakecaseBodyParamKeys: true,
 },

Comment on lines

+106
 to 
+108

@wobsorianowobsorianoJul 28, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I might use this new options param to override adding of secret key to the Authorization header for #6229
 });
 }
 public async deleteSamlConnection(samlConnectionId: string) {
Expand Down

41 changes: 31 additions & 10 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,22 +8,41 @@ import { assertValidSecretKey } from '../util/optionsAssertions';
import { joinPaths } from '../util/path';
import { deserialize } from './resources/Deserializer';

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 bodyParams?: Record<string, unknown> | Array<Record<string, unknown>>;
 formData?: FormData;
} & (
type ClerkBackendApiRequestOptionsUrlOrPath =
 | {
 url: string;
 path?: string;
 }
 | {
 url?: string;
 path: string;
 };

type ClerkBackendApiRequestOptionsBodyParams =
 | {
 bodyParams: Record<string, unknown> | Array<Record<string, unknown>>;
 options?: {
 /**
 * If true, snakecases the keys of the bodyParams object recursively.
 * @default false
 */
 deepSnakecaseBodyParamKeys?: boolean;
 };
 }
);
 | {
 bodyParams?: never;
 options?: {
 deepSnakecaseBodyParamKeys?: never;
 };
 };

export type ClerkBackendApiRequestOptions = {
 method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
 queryParams?: Record<string, unknown>;
 headerParams?: Record<string, string>;
 formData?: FormData;
} & ClerkBackendApiRequestOptionsUrlOrPath &
 ClerkBackendApiRequestOptionsBodyParams;

export type ClerkBackendApiResponse<T> =
 | {
Expand DownExpand Up@@ -78,7 +97,8 @@ export function buildRequest(options: BuildRequestOptions) {
 userAgent = USER_AGENT,
 skipApiVersionInUrl = false,
 } = options;
 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const { path, method, queryParams, headerParams, bodyParams, formData, options: opts } = requestOptions;
 const { deepSnakecaseBodyParamKeys = false } = opts || {};

 if (requireSecretKey) {
 assertValidSecretKey(secretKey);
Expand DownExpand Up@@ -130,7 +150,8 @@ export function buildRequest(options: BuildRequestOptions) {
 return null;
 }

 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) => snakecaseKeys(object, { deep: false });
 const formatKeys = (object: Parameters<typeof snakecaseKeys>[0]) =>
 snakecaseKeys(object, { deep: deepSnakecaseBodyParamKeys });

 return {
 body: JSON.stringify(Array.isArray(bodyParams) ? bodyParams.map(formatKeys) : formatKeys(bodyParams)),
Expand Down
Loading