From bf7995a0cf6e9728b4e7fc10440e7c3ba3da4a7e Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Wed, 5 Nov 2025 12:25:48 -0800 Subject: [PATCH 1/6] fix(backend): Adjust api keys list method response type --- packages/backend/src/api/endpoints/APIKeysApi.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/backend/src/api/endpoints/APIKeysApi.ts b/packages/backend/src/api/endpoints/APIKeysApi.ts index cc78e803299..89e948060b6 100644 --- a/packages/backend/src/api/endpoints/APIKeysApi.ts +++ b/packages/backend/src/api/endpoints/APIKeysApi.ts @@ -1,5 +1,6 @@ -import type { ClerkPaginationRequest } from '@clerk/types'; +import type { ClerkPaginationRequest } from '@clerk/shared/types'; +import type { PaginatedResourceResponse } from '../../api/resources/Deserializer'; import { joinPaths } from '../../util/path'; import type { APIKey } from '../resources/APIKey'; import { AbstractAPI } from './AbstractApi'; @@ -52,7 +53,7 @@ type RevokeAPIKeyParams = { export class APIKeysAPI extends AbstractAPI { async list(queryParams: GetAPIKeyListParams) { - return this.request({ + return this.request>({ method: 'GET', path: basePath, queryParams, From 7e207c941a833ff169bc4870c6ecec77891bb2f5 Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Wed, 5 Nov 2025 12:34:54 -0800 Subject: [PATCH 2/6] chore: remove getSecret method from api keys --- packages/backend/src/api/endpoints/APIKeysApi.ts | 9 --------- 1 file changed, 9 deletions(-) diff --git a/packages/backend/src/api/endpoints/APIKeysApi.ts b/packages/backend/src/api/endpoints/APIKeysApi.ts index 89e948060b6..1d0cce1ea95 100644 --- a/packages/backend/src/api/endpoints/APIKeysApi.ts +++ b/packages/backend/src/api/endpoints/APIKeysApi.ts @@ -80,15 +80,6 @@ export class APIKeysAPI extends AbstractAPI { }); } - async getSecret(apiKeyId: string) { - this.requireId(apiKeyId); - - return this.request<{ secret: string }>({ - method: 'GET', - path: joinPaths(basePath, apiKeyId, 'secret'), - }); - } - async verifySecret(secret: string) { return this.request({ method: 'POST', From 8bdc97bad1e615da8052f53246218a6871def3d6 Mon Sep 17 00:00:00 2001 From: wobsoriano Date: Wed, 5 Nov 2025 12:39:09 -0800 Subject: [PATCH 3/6] chore: revert getSecret --- packages/backend/src/api/endpoints/APIKeysApi.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/packages/backend/src/api/endpoints/APIKeysApi.ts b/packages/backend/src/api/endpoints/APIKeysApi.ts index 1d0cce1ea95..89e948060b6 100644 --- a/packages/backend/src/api/endpoints/APIKeysApi.ts +++ b/packages/backend/src/api/endpoints/APIKeysApi.ts @@ -80,6 +80,15 @@ export class APIKeysAPI extends AbstractAPI { }); } + async getSecret(apiKeyId: string) { + this.requireId(apiKeyId); + + return this.request<{ secret: string }>({ + method: 'GET', + path: joinPaths(basePath, apiKeyId, 'secret'), + }); + } + async verifySecret(secret: string) { return this.request({ method: 'POST', From 507f51d689d51077254fdac420ed1e7e8d7bfdd3 Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Wed, 5 Nov 2025 12:39:46 -0800 Subject: [PATCH 4/6] chore: add changeset --- .changeset/famous-planes-invent.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/famous-planes-invent.md diff --git a/.changeset/famous-planes-invent.md b/.changeset/famous-planes-invent.md new file mode 100644 index 00000000000..ec3205bae69 --- /dev/null +++ b/.changeset/famous-planes-invent.md @@ -0,0 +1,5 @@ +--- +"@clerk/backend": patch +--- + +Fixed API keys `list` method return type From b0cb851b97308fd768f593fe30d033e5b99a31ca Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Wed, 5 Nov 2025 12:48:04 -0800 Subject: [PATCH 5/6] chore: update changeset --- .changeset/famous-planes-invent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/famous-planes-invent.md b/.changeset/famous-planes-invent.md index ec3205bae69..cd1a1011582 100644 --- a/.changeset/famous-planes-invent.md +++ b/.changeset/famous-planes-invent.md @@ -1,5 +1,5 @@ --- -"@clerk/backend": patch +"@clerk/backend": minor --- Fixed API keys `list` method return type From 88d0d6327495ae05b3e7a9c4a6a28e145d4e755f Mon Sep 17 00:00:00 2001 From: Robert Soriano Date: Wed, 5 Nov 2025 12:51:19 -0800 Subject: [PATCH 6/6] chore: update changeset --- .changeset/famous-planes-invent.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.changeset/famous-planes-invent.md b/.changeset/famous-planes-invent.md index cd1a1011582..22a6377d897 100644 --- a/.changeset/famous-planes-invent.md +++ b/.changeset/famous-planes-invent.md @@ -3,3 +3,10 @@ --- Fixed API keys `list` method return type + +```ts +const apiKeys = await clerkClient.apiKeys.list({ subject: 'user_xxxxx' }) + +apiKeys.data +apiKeys.totalCount +```