chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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
wobsoriano merged 9 commits into from
Mar 30, 2026
Merged

chore(ui,shared,localizations): Improve error handling when creating API keys #8056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
751d460
chore: Improve error handling when creating API keys
wobsoriano Mar 12, 2026
39a9bc2
chore: remove versioning from mock API keys POST route
wobsoriano Mar 12, 2026
5fd2a11
chore: more test fixes
wobsoriano Mar 12, 2026
4d26078
chore: retry
wobsoriano Mar 12, 2026
517cbbe
chore: add duplicate api key name test
wobsoriano Mar 13, 2026
1726683
chore: restore error handling and localization changes lost during re…
wobsoriano Mar 26, 2026
3d99c35
Merge branch 'main' into rob/api-keys-usage-exceeded
wobsoriano Mar 30, 2026
a217dd6
Merge branch 'main' into rob/api-keys-usage-exceeded
jacekradko Mar 30, 2026
2384233
chore: improve error handling with error code matching and fallback
wobsoriano Mar 30, 2026
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
7 changes: 7 additions & 0 deletions .changeset/cyan-elephants-roll.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.
74 changes: 74 additions & 0 deletions integration/tests/api-keys-component.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
}
});
});

test('shows error when creating API key with duplicate name', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
await u.po.expect.toBeSignedIn();

await u.po.page.goToRelative('/api-keys');
await u.po.apiKeys.waitForMounted();

const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

// Create the first API key
await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(duplicateName);
await u.po.apiKeys.selectExpiration('1d');
await u.po.apiKeys.clickSaveButton();

await u.po.apiKeys.waitForCopyModalOpened();
await u.po.apiKeys.clickCopyAndCloseButton();
await u.po.apiKeys.waitForCopyModalClosed();
await u.po.apiKeys.waitForFormClosed();

// Try to create another API key with the same name
await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(duplicateName);
await u.po.apiKeys.selectExpiration('1d');
await u.po.apiKeys.clickSaveButton();

// Verify error message is displayed
await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
});

test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });
await u.po.signIn.goTo();
await u.po.signIn.waitForMounted();
await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
await u.po.expect.toBeSignedIn();

// Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
await page.route('*/**/api_keys*', async route => {
if (route.request().method() === 'POST') {
await route.fulfill({
status: 403,
contentType: 'application/json',
body: JSON.stringify({
errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
}),
});
} else {
await route.continue();
}
});

await u.po.page.goToRelative('/api-keys');
await u.po.apiKeys.waitForMounted();

await u.po.apiKeys.clickAddButton();
await u.po.apiKeys.waitForFormOpened();
await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
await u.po.apiKeys.selectExpiration('1d');
await u.po.apiKeys.clickSaveButton();

// Verify error message is displayed
await expect(
u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
).toBeVisible({ timeout: 5000 });

await u.page.unrouteAll();
});
});
2 changes: 2 additions & 0 deletions packages/localizations/src/en-US.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
},
unstable__errors: {
already_a_member_in_organization: '{{email}} is already a member of the organization.',
api_key_name_already_exists: 'API Key name already exists.',
api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
captcha_invalid: undefined,
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/types/localization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
organization_domain_common: LocalizationValue;
organization_domain_blocked: LocalizationValue;
organization_domain_exists_for_enterprise_connection: LocalizationValue;
api_key_name_already_exists: LocalizationValue;
api_key_usage_exceeded: LocalizationValue;
organization_membership_quota_exceeded: LocalizationValue;
organization_not_found_or_unauthorized: LocalizationValue;
organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down
21 changes: 16 additions & 5 deletions packages/ui/src/components/APIKeys/APIKeys.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
...params,
subject,
});
invalidateAll();
void invalidateAll();
card.setError(undefined);
setIsCopyModalOpen(true);
setAPIKey(apiKey);
} catch (err: any) {

@jacekradkojacekradkoMar 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?

@wobsorianowobsorianoMar 30, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)

if (isClerkAPIResponseError(err)) {
if (err.status === 409) {
card.setError('API Key name already exists');
}
if (!isClerkAPIResponseError(err)) {
handleError(err, [], card.setError);
return;
}

switch (err.errors?.[0]?.code) {
case 'token_quota_exceeded':
card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
break;
case 'token_creation_conflict':
card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
break;
default:
handleError(err, [], card.setError);
}
} finally {
card.setIdle();
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
chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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

wobsoriano
merged 9 commits into

from

Mar 30, 2026
 Merged


chore(ui,shared,localizations): Improve error handling when creating API keys
#8056
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
751d460

chore: Improve error handling when creating API keys


wobsoriano Mar 12, 2026
39a9bc2

chore: remove versioning from mock API keys POST route


wobsoriano Mar 12, 2026
5fd2a11

chore: more test fixes


wobsoriano Mar 12, 2026
4d26078

chore: retry


wobsoriano Mar 12, 2026
517cbbe

chore: add duplicate api key name test


wobsoriano Mar 13, 2026
1726683

chore: restore error handling and localization changes lost during re…


wobsoriano Mar 26, 2026
3d99c35

Merge branch 'main' into rob/api-keys-usage-exceeded


wobsoriano Mar 30, 2026
a217dd6

Merge branch 'main' into rob/api-keys-usage-exceeded


jacekradko Mar 30, 2026
2384233

chore: improve error handling with error code matching and fallback


wobsoriano Mar 30, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/cyan-elephants-roll.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.

74 changes: 74 additions & 0 deletions
integration/tests/api-keys-component.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
 }
 });
 });

 test('shows error when creating API key with duplicate name', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

 // Create the first API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForCopyModalOpened();
 await u.po.apiKeys.clickCopyAndCloseButton();
 await u.po.apiKeys.waitForCopyModalClosed();
 await u.po.apiKeys.waitForFormClosed();

 // Try to create another API key with the same name
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
 });

 test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 // Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
 await page.route('*/**/api_keys*', async route => {
 if (route.request().method() === 'POST') {
 await route.fulfill({
 status: 403,
 contentType: 'application/json',
 body: JSON.stringify({
 errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
 }),
 });
 } else {
 await route.continue();
 }
 });

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(
 u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
 ).toBeVisible({ timeout: 5000 });

 await u.page.unrouteAll();
 });
});

2 changes: 2 additions & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
 },
 unstable__errors: {
 already_a_member_in_organization: '{{email}} is already a member of the organization.',
 api_key_name_already_exists: 'API Key name already exists.',
 api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
 avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
 avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
 captcha_invalid: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
 organization_domain_common: LocalizationValue;
 organization_domain_blocked: LocalizationValue;
 organization_domain_exists_for_enterprise_connection: LocalizationValue;
 api_key_name_already_exists: LocalizationValue;
 api_key_usage_exceeded: LocalizationValue;
 organization_membership_quota_exceeded: LocalizationValue;
 organization_not_found_or_unauthorized: LocalizationValue;
 organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down

21 changes: 16 additions & 5 deletions
packages/ui/src/components/APIKeys/APIKeys.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
 ...params,
 subject,
 });
 invalidateAll();
void invalidateAll();
 card.setError(undefined);
 setIsCopyModalOpen(true);
 setAPIKey(apiKey);
 } catch (err: any) {
@jacekradkojacekradkoMar 30, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?
@wobsorianowobsorianoMar 30, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)
 if (isClerkAPIResponseError(err)) {
 if (err.status === 409) {
 card.setError('API Key name already exists');
 }
 if (!isClerkAPIResponseError(err)) {
 handleError(err, [], card.setError);
 return;
 }

 switch (err.errors?.[0]?.code) {
 case 'token_quota_exceeded':
 card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
 break;
 case 'token_creation_conflict':
 card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
 break;
 default:
 handleError(err, [], card.setError);
 }
 } finally {
 card.setIdle();
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
chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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

wobsoriano
merged 9 commits into

from

Mar 30, 2026
 Merged


chore(ui,shared,localizations): Improve error handling when creating API keys
#8056
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
751d460

chore: Improve error handling when creating API keys


wobsoriano Mar 12, 2026
39a9bc2

chore: remove versioning from mock API keys POST route


wobsoriano Mar 12, 2026
5fd2a11

chore: more test fixes


wobsoriano Mar 12, 2026
4d26078

chore: retry


wobsoriano Mar 12, 2026
517cbbe

chore: add duplicate api key name test


wobsoriano Mar 13, 2026
1726683

chore: restore error handling and localization changes lost during re…


wobsoriano Mar 26, 2026
3d99c35

Merge branch 'main' into rob/api-keys-usage-exceeded


wobsoriano Mar 30, 2026
a217dd6

Merge branch 'main' into rob/api-keys-usage-exceeded


jacekradko Mar 30, 2026
2384233

chore: improve error handling with error code matching and fallback


wobsoriano Mar 30, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/cyan-elephants-roll.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.

74 changes: 74 additions & 0 deletions
integration/tests/api-keys-component.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
 }
 });
 });

 test('shows error when creating API key with duplicate name', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

 // Create the first API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForCopyModalOpened();
 await u.po.apiKeys.clickCopyAndCloseButton();
 await u.po.apiKeys.waitForCopyModalClosed();
 await u.po.apiKeys.waitForFormClosed();

 // Try to create another API key with the same name
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
 });

 test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 // Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
 await page.route('*/**/api_keys*', async route => {
 if (route.request().method() === 'POST') {
 await route.fulfill({
 status: 403,
 contentType: 'application/json',
 body: JSON.stringify({
 errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
 }),
 });
 } else {
 await route.continue();
 }
 });

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(
 u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
 ).toBeVisible({ timeout: 5000 });

 await u.page.unrouteAll();
 });
});

2 changes: 2 additions & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
 },
 unstable__errors: {
 already_a_member_in_organization: '{{email}} is already a member of the organization.',
 api_key_name_already_exists: 'API Key name already exists.',
 api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
 avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
 avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
 captcha_invalid: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
 organization_domain_common: LocalizationValue;
 organization_domain_blocked: LocalizationValue;
 organization_domain_exists_for_enterprise_connection: LocalizationValue;
 api_key_name_already_exists: LocalizationValue;
 api_key_usage_exceeded: LocalizationValue;
 organization_membership_quota_exceeded: LocalizationValue;
 organization_not_found_or_unauthorized: LocalizationValue;
 organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down

21 changes: 16 additions & 5 deletions
packages/ui/src/components/APIKeys/APIKeys.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
 ...params,
 subject,
 });
 invalidateAll();
void invalidateAll();
 card.setError(undefined);
 setIsCopyModalOpen(true);
 setAPIKey(apiKey);
 } catch (err: any) {
@jacekradkojacekradkoMar 30, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?
@wobsorianowobsorianoMar 30, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)
 if (isClerkAPIResponseError(err)) {
 if (err.status === 409) {
 card.setError('API Key name already exists');
 }
 if (!isClerkAPIResponseError(err)) {
 handleError(err, [], card.setError);
 return;
 }

 switch (err.errors?.[0]?.code) {
 case 'token_quota_exceeded':
 card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
 break;
 case 'token_creation_conflict':
 card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
 break;
 default:
 handleError(err, [], card.setError);
 }
 } finally {
 card.setIdle();
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
chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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

wobsoriano
merged 9 commits into

from

Mar 30, 2026
 Merged


chore(ui,shared,localizations): Improve error handling when creating API keys
#8056
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
751d460

chore: Improve error handling when creating API keys


wobsoriano Mar 12, 2026
39a9bc2

chore: remove versioning from mock API keys POST route


wobsoriano Mar 12, 2026
5fd2a11

chore: more test fixes


wobsoriano Mar 12, 2026
4d26078

chore: retry


wobsoriano Mar 12, 2026
517cbbe

chore: add duplicate api key name test


wobsoriano Mar 13, 2026
1726683

chore: restore error handling and localization changes lost during re…


wobsoriano Mar 26, 2026
3d99c35

Merge branch 'main' into rob/api-keys-usage-exceeded


wobsoriano Mar 30, 2026
a217dd6

Merge branch 'main' into rob/api-keys-usage-exceeded


jacekradko Mar 30, 2026
2384233

chore: improve error handling with error code matching and fallback


wobsoriano Mar 30, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/cyan-elephants-roll.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.

74 changes: 74 additions & 0 deletions
integration/tests/api-keys-component.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
 }
 });
 });

 test('shows error when creating API key with duplicate name', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

 // Create the first API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForCopyModalOpened();
 await u.po.apiKeys.clickCopyAndCloseButton();
 await u.po.apiKeys.waitForCopyModalClosed();
 await u.po.apiKeys.waitForFormClosed();

 // Try to create another API key with the same name
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
 });

 test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 // Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
 await page.route('*/**/api_keys*', async route => {
 if (route.request().method() === 'POST') {
 await route.fulfill({
 status: 403,
 contentType: 'application/json',
 body: JSON.stringify({
 errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
 }),
 });
 } else {
 await route.continue();
 }
 });

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(
 u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
 ).toBeVisible({ timeout: 5000 });

 await u.page.unrouteAll();
 });
});

2 changes: 2 additions & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
 },
 unstable__errors: {
 already_a_member_in_organization: '{{email}} is already a member of the organization.',
 api_key_name_already_exists: 'API Key name already exists.',
 api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
 avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
 avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
 captcha_invalid: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
 organization_domain_common: LocalizationValue;
 organization_domain_blocked: LocalizationValue;
 organization_domain_exists_for_enterprise_connection: LocalizationValue;
 api_key_name_already_exists: LocalizationValue;
 api_key_usage_exceeded: LocalizationValue;
 organization_membership_quota_exceeded: LocalizationValue;
 organization_not_found_or_unauthorized: LocalizationValue;
 organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down

21 changes: 16 additions & 5 deletions
packages/ui/src/components/APIKeys/APIKeys.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
 ...params,
 subject,
 });
 invalidateAll();
void invalidateAll();
 card.setError(undefined);
 setIsCopyModalOpen(true);
 setAPIKey(apiKey);
 } catch (err: any) {
@jacekradkojacekradkoMar 30, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?
@wobsorianowobsorianoMar 30, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)
 if (isClerkAPIResponseError(err)) {
 if (err.status === 409) {
 card.setError('API Key name already exists');
 }
 if (!isClerkAPIResponseError(err)) {
 handleError(err, [], card.setError);
 return;
 }

 switch (err.errors?.[0]?.code) {
 case 'token_quota_exceeded':
 card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
 break;
 case 'token_creation_conflict':
 card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
 break;
 default:
 handleError(err, [], card.setError);
 }
 } finally {
 card.setIdle();
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
chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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

wobsoriano
merged 9 commits into

from

Mar 30, 2026
 Merged


chore(ui,shared,localizations): Improve error handling when creating API keys
#8056
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
751d460

chore: Improve error handling when creating API keys


wobsoriano Mar 12, 2026
39a9bc2

chore: remove versioning from mock API keys POST route


wobsoriano Mar 12, 2026
5fd2a11

chore: more test fixes


wobsoriano Mar 12, 2026
4d26078

chore: retry


wobsoriano Mar 12, 2026
517cbbe

chore: add duplicate api key name test


wobsoriano Mar 13, 2026
1726683

chore: restore error handling and localization changes lost during re…


wobsoriano Mar 26, 2026
3d99c35

Merge branch 'main' into rob/api-keys-usage-exceeded


wobsoriano Mar 30, 2026
a217dd6

Merge branch 'main' into rob/api-keys-usage-exceeded


jacekradko Mar 30, 2026
2384233

chore: improve error handling with error code matching and fallback


wobsoriano Mar 30, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/cyan-elephants-roll.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.

74 changes: 74 additions & 0 deletions
integration/tests/api-keys-component.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
 }
 });
 });

 test('shows error when creating API key with duplicate name', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

 // Create the first API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForCopyModalOpened();
 await u.po.apiKeys.clickCopyAndCloseButton();
 await u.po.apiKeys.waitForCopyModalClosed();
 await u.po.apiKeys.waitForFormClosed();

 // Try to create another API key with the same name
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
 });

 test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 // Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
 await page.route('*/**/api_keys*', async route => {
 if (route.request().method() === 'POST') {
 await route.fulfill({
 status: 403,
 contentType: 'application/json',
 body: JSON.stringify({
 errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
 }),
 });
 } else {
 await route.continue();
 }
 });

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(
 u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
 ).toBeVisible({ timeout: 5000 });

 await u.page.unrouteAll();
 });
});

2 changes: 2 additions & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
 },
 unstable__errors: {
 already_a_member_in_organization: '{{email}} is already a member of the organization.',
 api_key_name_already_exists: 'API Key name already exists.',
 api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
 avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
 avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
 captcha_invalid: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
 organization_domain_common: LocalizationValue;
 organization_domain_blocked: LocalizationValue;
 organization_domain_exists_for_enterprise_connection: LocalizationValue;
 api_key_name_already_exists: LocalizationValue;
 api_key_usage_exceeded: LocalizationValue;
 organization_membership_quota_exceeded: LocalizationValue;
 organization_not_found_or_unauthorized: LocalizationValue;
 organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down

21 changes: 16 additions & 5 deletions
packages/ui/src/components/APIKeys/APIKeys.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
 ...params,
 subject,
 });
 invalidateAll();
void invalidateAll();
 card.setError(undefined);
 setIsCopyModalOpen(true);
 setAPIKey(apiKey);
 } catch (err: any) {
@jacekradkojacekradkoMar 30, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?
@wobsorianowobsorianoMar 30, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)
 if (isClerkAPIResponseError(err)) {
 if (err.status === 409) {
 card.setError('API Key name already exists');
 }
 if (!isClerkAPIResponseError(err)) {
 handleError(err, [], card.setError);
 return;
 }

 switch (err.errors?.[0]?.code) {
 case 'token_quota_exceeded':
 card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
 break;
 case 'token_creation_conflict':
 card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
 break;
 default:
 handleError(err, [], card.setError);
 }
 } finally {
 card.setIdle();
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
chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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

wobsoriano
merged 9 commits into

from

Mar 30, 2026
 Merged


chore(ui,shared,localizations): Improve error handling when creating API keys
#8056
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
751d460

chore: Improve error handling when creating API keys


wobsoriano Mar 12, 2026
39a9bc2

chore: remove versioning from mock API keys POST route


wobsoriano Mar 12, 2026
5fd2a11

chore: more test fixes


wobsoriano Mar 12, 2026
4d26078

chore: retry


wobsoriano Mar 12, 2026
517cbbe

chore: add duplicate api key name test


wobsoriano Mar 13, 2026
1726683

chore: restore error handling and localization changes lost during re…


wobsoriano Mar 26, 2026
3d99c35

Merge branch 'main' into rob/api-keys-usage-exceeded


wobsoriano Mar 30, 2026
a217dd6

Merge branch 'main' into rob/api-keys-usage-exceeded


jacekradko Mar 30, 2026
2384233

chore: improve error handling with error code matching and fallback


wobsoriano Mar 30, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/cyan-elephants-roll.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.

74 changes: 74 additions & 0 deletions
integration/tests/api-keys-component.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
 }
 });
 });

 test('shows error when creating API key with duplicate name', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

 // Create the first API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForCopyModalOpened();
 await u.po.apiKeys.clickCopyAndCloseButton();
 await u.po.apiKeys.waitForCopyModalClosed();
 await u.po.apiKeys.waitForFormClosed();

 // Try to create another API key with the same name
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
 });

 test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 // Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
 await page.route('*/**/api_keys*', async route => {
 if (route.request().method() === 'POST') {
 await route.fulfill({
 status: 403,
 contentType: 'application/json',
 body: JSON.stringify({
 errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
 }),
 });
 } else {
 await route.continue();
 }
 });

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(
 u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
 ).toBeVisible({ timeout: 5000 });

 await u.page.unrouteAll();
 });
});

2 changes: 2 additions & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
 },
 unstable__errors: {
 already_a_member_in_organization: '{{email}} is already a member of the organization.',
 api_key_name_already_exists: 'API Key name already exists.',
 api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
 avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
 avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
 captcha_invalid: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
 organization_domain_common: LocalizationValue;
 organization_domain_blocked: LocalizationValue;
 organization_domain_exists_for_enterprise_connection: LocalizationValue;
 api_key_name_already_exists: LocalizationValue;
 api_key_usage_exceeded: LocalizationValue;
 organization_membership_quota_exceeded: LocalizationValue;
 organization_not_found_or_unauthorized: LocalizationValue;
 organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down

21 changes: 16 additions & 5 deletions
packages/ui/src/components/APIKeys/APIKeys.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
 ...params,
 subject,
 });
 invalidateAll();
void invalidateAll();
 card.setError(undefined);
 setIsCopyModalOpen(true);
 setAPIKey(apiKey);
 } catch (err: any) {
@jacekradkojacekradkoMar 30, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?
@wobsorianowobsorianoMar 30, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)
 if (isClerkAPIResponseError(err)) {
 if (err.status === 409) {
 card.setError('API Key name already exists');
 }
 if (!isClerkAPIResponseError(err)) {
 handleError(err, [], card.setError);
 return;
 }

 switch (err.errors?.[0]?.code) {
 case 'token_quota_exceeded':
 card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
 break;
 case 'token_creation_conflict':
 card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
 break;
 default:
 handleError(err, [], card.setError);
 }
 } finally {
 card.setIdle();
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
chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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

wobsoriano
merged 9 commits into

from

Mar 30, 2026
 Merged


chore(ui,shared,localizations): Improve error handling when creating API keys
#8056
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
751d460

chore: Improve error handling when creating API keys


wobsoriano Mar 12, 2026
39a9bc2

chore: remove versioning from mock API keys POST route


wobsoriano Mar 12, 2026
5fd2a11

chore: more test fixes


wobsoriano Mar 12, 2026
4d26078

chore: retry


wobsoriano Mar 12, 2026
517cbbe

chore: add duplicate api key name test


wobsoriano Mar 13, 2026
1726683

chore: restore error handling and localization changes lost during re…


wobsoriano Mar 26, 2026
3d99c35

Merge branch 'main' into rob/api-keys-usage-exceeded


wobsoriano Mar 30, 2026
a217dd6

Merge branch 'main' into rob/api-keys-usage-exceeded


jacekradko Mar 30, 2026
2384233

chore: improve error handling with error code matching and fallback


wobsoriano Mar 30, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/cyan-elephants-roll.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.

74 changes: 74 additions & 0 deletions
integration/tests/api-keys-component.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
 }
 });
 });

 test('shows error when creating API key with duplicate name', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

 // Create the first API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForCopyModalOpened();
 await u.po.apiKeys.clickCopyAndCloseButton();
 await u.po.apiKeys.waitForCopyModalClosed();
 await u.po.apiKeys.waitForFormClosed();

 // Try to create another API key with the same name
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
 });

 test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 // Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
 await page.route('*/**/api_keys*', async route => {
 if (route.request().method() === 'POST') {
 await route.fulfill({
 status: 403,
 contentType: 'application/json',
 body: JSON.stringify({
 errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
 }),
 });
 } else {
 await route.continue();
 }
 });

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(
 u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
 ).toBeVisible({ timeout: 5000 });

 await u.page.unrouteAll();
 });
});

2 changes: 2 additions & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
 },
 unstable__errors: {
 already_a_member_in_organization: '{{email}} is already a member of the organization.',
 api_key_name_already_exists: 'API Key name already exists.',
 api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
 avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
 avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
 captcha_invalid: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
 organization_domain_common: LocalizationValue;
 organization_domain_blocked: LocalizationValue;
 organization_domain_exists_for_enterprise_connection: LocalizationValue;
 api_key_name_already_exists: LocalizationValue;
 api_key_usage_exceeded: LocalizationValue;
 organization_membership_quota_exceeded: LocalizationValue;
 organization_not_found_or_unauthorized: LocalizationValue;
 organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down

21 changes: 16 additions & 5 deletions
packages/ui/src/components/APIKeys/APIKeys.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
 ...params,
 subject,
 });
 invalidateAll();
void invalidateAll();
 card.setError(undefined);
 setIsCopyModalOpen(true);
 setAPIKey(apiKey);
 } catch (err: any) {
@jacekradkojacekradkoMar 30, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?
@wobsorianowobsorianoMar 30, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)
 if (isClerkAPIResponseError(err)) {
 if (err.status === 409) {
 card.setError('API Key name already exists');
 }
 if (!isClerkAPIResponseError(err)) {
 handleError(err, [], card.setError);
 return;
 }

 switch (err.errors?.[0]?.code) {
 case 'token_quota_exceeded':
 card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
 break;
 case 'token_creation_conflict':
 card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
 break;
 default:
 handleError(err, [], card.setError);
 }
 } finally {
 card.setIdle();
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
chore(ui,shared,localizations): Improve error handling when creating API keys#8056

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

wobsoriano
merged 9 commits into

from

Mar 30, 2026
 Merged


chore(ui,shared,localizations): Improve error handling when creating API keys
#8056
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
751d460

chore: Improve error handling when creating API keys


wobsoriano Mar 12, 2026
39a9bc2

chore: remove versioning from mock API keys POST route


wobsoriano Mar 12, 2026
5fd2a11

chore: more test fixes


wobsoriano Mar 12, 2026
4d26078

chore: retry


wobsoriano Mar 12, 2026
517cbbe

chore: add duplicate api key name test


wobsoriano Mar 13, 2026
1726683

chore: restore error handling and localization changes lost during re…


wobsoriano Mar 26, 2026
3d99c35

Merge branch 'main' into rob/api-keys-usage-exceeded


wobsoriano Mar 30, 2026
a217dd6

Merge branch 'main' into rob/api-keys-usage-exceeded


jacekradko Mar 30, 2026
2384233

chore: improve error handling with error code matching and fallback


wobsoriano Mar 30, 2026

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


7 changes: 7 additions & 0 deletions
.changeset/cyan-elephants-roll.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/localizations": patch
"@clerk/shared": patch
"@clerk/ui": patch
---

Improved error handling when creating API keys.

74 changes: 74 additions & 0 deletions
integration/tests/api-keys-component.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -757,4 +757,78 @@ test.describe('api keys component @machine', () => {
 }
 });
 });

 test('shows error when creating API key with duplicate name', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 const duplicateName = `${fakeAdmin.firstName}-duplicate-${Date.now()}`;

 // Create the first API key
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 await u.po.apiKeys.waitForCopyModalOpened();
 await u.po.apiKeys.clickCopyAndCloseButton();
 await u.po.apiKeys.waitForCopyModalClosed();
 await u.po.apiKeys.waitForFormClosed();

 // Try to create another API key with the same name
 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(duplicateName);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(u.page.getByText('API Key name already exists.')).toBeVisible({ timeout: 5000 });
 });

 test('shows error when API key usage is exceeded for free plan', async ({ page, context }) => {
 const u = createTestUtils({ app, page, context });
 await u.po.signIn.goTo();
 await u.po.signIn.waitForMounted();
 await u.po.signIn.signInWithEmailAndInstantPassword({ email: fakeAdmin.email, password: fakeAdmin.password });
 await u.po.expect.toBeSignedIn();

 // Mock the API keys create endpoint to return 403 for free plan users who exceed free tier limits
 await page.route('*/**/api_keys*', async route => {
 if (route.request().method() === 'POST') {
 await route.fulfill({
 status: 403,
 contentType: 'application/json',
 body: JSON.stringify({
 errors: [{ code: 'token_quota_exceeded', message: 'Token quota exceeded' }],
 }),
 });
 } else {
 await route.continue();
 }
 });

 await u.po.page.goToRelative('/api-keys');
 await u.po.apiKeys.waitForMounted();

 await u.po.apiKeys.clickAddButton();
 await u.po.apiKeys.waitForFormOpened();
 await u.po.apiKeys.typeName(`${fakeAdmin.firstName}-test-usage-exceeded`);
 await u.po.apiKeys.selectExpiration('1d');
 await u.po.apiKeys.clickSaveButton();

 // Verify error message is displayed
 await expect(
 u.page.getByText('You have reached your usage limit. You can remove the limit by upgrading to a paid plan.'),
 ).toBeVisible({ timeout: 5000 });

 await u.page.unrouteAll();
 });
});

2 changes: 2 additions & 0 deletions
packages/localizations/src/en-US.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -975,6 +975,8 @@ export const enUS: LocalizationResource = {
 },
 unstable__errors: {
 already_a_member_in_organization: '{{email}} is already a member of the organization.',
 api_key_name_already_exists: 'API Key name already exists.',
 api_key_usage_exceeded: 'You have reached your usage limit. You can remove the limit by upgrading to a paid plan.',
 avatar_file_size_exceeded: 'File size exceeds the maximum limit of 10MB. Please choose a smaller file.',
 avatar_file_type_invalid: 'File type not supported. Please upload a JPG, PNG, GIF, or WEBP image.',
 captcha_invalid: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1508,6 +1508,8 @@ type UnstableErrors = WithParamName<{
 organization_domain_common: LocalizationValue;
 organization_domain_blocked: LocalizationValue;
 organization_domain_exists_for_enterprise_connection: LocalizationValue;
 api_key_name_already_exists: LocalizationValue;
 api_key_usage_exceeded: LocalizationValue;
 organization_membership_quota_exceeded: LocalizationValue;
 organization_not_found_or_unauthorized: LocalizationValue;
 organization_not_found_or_unauthorized_with_create_organization_disabled: LocalizationValue;
Expand Down

21 changes: 16 additions & 5 deletions
packages/ui/src/components/APIKeys/APIKeys.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,7 @@ import { useCardState, withCardStateProvider } from '@/ui/elements/contexts';
import { InputWithIcon } from '@/ui/elements/InputWithIcon';
import { Pagination } from '@/ui/elements/Pagination';
import { useDebounce } from '@/ui/hooks';
import { handleError } from '@/ui/utils/errorHandler';
import { MagnifyingGlass } from '@/ui/icons';
import { mqu } from '@/ui/styledSystem';

Expand DownExpand Up@@ -114,15 +115,25 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
 ...params,
 subject,
 });
 invalidateAll();
void invalidateAll();
 card.setError(undefined);
 setIsCopyModalOpen(true);
 setAPIKey(apiKey);
 } catch (err: any) {
@jacekradkojacekradkoMar 30, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

This is a pre-existing issue, but it seems like we are only handling Clerk errors here, but silently ignoring all other errors. Wouldn't this leave the component in a transient state on other errors?
@wobsorianowobsorianoMar 30, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Updated! It now matches on the actual error code instead of HTTP status, and falls back to handleError which handles all kind of errors so they don't get silently swallowed. This matches the pattern used in other components (UserMembershipList, InviteMembersForm, and ChooseOrganizationScreen.)
 if (isClerkAPIResponseError(err)) {
 if (err.status === 409) {
 card.setError('API Key name already exists');
 }
 if (!isClerkAPIResponseError(err)) {
 handleError(err, [], card.setError);
 return;
 }

 switch (err.errors?.[0]?.code) {
 case 'token_quota_exceeded':
 card.setError(t(localizationKeys('unstable__errors.api_key_usage_exceeded')));
 break;
 case 'token_creation_conflict':
 card.setError(t(localizationKeys('unstable__errors.api_key_name_already_exists')));
 break;
 default:
 handleError(err, [], card.setError);
 }
 } finally {
 card.setIdle();
Expand Down
Loading