chore(backend): Add API keys list method#6948

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

coderabbitai · 2025-10-09T04:22:56Z

🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
Add explicit return type, JSDoc documentation, and parameter validation.
The method has several issues that should be addressed:
Missing explicit return type: Per coding guidelines, public APIs must have explicit return types for clarity and type safety.
Missing JSDoc documentation: Per coding guidelines, all public APIs must be documented with JSDoc comments.
Missing parameter validation: The subject parameter is required but not validated. Other methods in this class (e.g., revoke, getSecret) validate ID parameters using this.requireId().
Apply this diff to add return type, JSDoc, and validation:
+ /**+ * List API keys for a user or organization+ * + * @param queryParams - Query parameters including subject, pagination, and filter options+ * @returns Promise resolving to an array of APIKey objects+ */- async list(queryParams: GetAPIKeyListParams) {+ async list(queryParams: GetAPIKeyListParams): Promise<APIKey[]> {+ this.requireId(queryParams.subject);+ return this.request<APIKey[]>({ method: 'GET', path: basePath, queryParams, }); }
Additionally, verify whether the API response includes pagination metadata (total count, hasMore, etc.) or just returns an array:
🏁 Script executed:
#!/bin/bash# Description: Check how other list methods in the API handle pagination responses# Search for other list methods to understand the pagination pattern ast-grep --pattern $'async list($$$) { $$$ return this.request$$$}'# Also check if there are pagination response types defined rg -nP --type=ts 'Paginated|PaginationResponse|ListResponse' -C3
Length of output: 99058
🏁 Script executed:
#!/bin/bash rg -nP --type=ts 'GetAPIKeyListParams\b' -C3 packages/backend/src/api
Length of output: 1054
Use paginated response type and validate subject ID
Validate the required subject via this.requireId(queryParams.subject) before calling the API.
Change the signature to
async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>>
and update the request generic to PaginatedResourceResponse<APIKey[]>.
🤖 Prompt for AI Agents
In packages/backend/src/api/endpoints/APIKeysApi.ts around lines 54 to 60, the list method must validate the required subject ID and return a paginated response type: call this.requireId(queryParams.subject) at the top of the method to validate the subject, change the method signature to async list(queryParams: GetAPIKeyListParams): Promise<PaginatedResourceResponse<APIKey[]>> and update the this.request generic to PaginatedResourceResponse<APIKey[]> so the API call returns the paginated shape.

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+---
+"@clerk/backend": patch
+---
+Added API keys list method to the backend SDK client

-Original file line number
+Diff line change
@@ -1,17 +1,32 @@
+import type { ClerkPaginationRequest } from '@clerk/types';
 import { joinPaths } from '../../util/path';
 import type { APIKey } from '../resources/APIKey';
 import { AbstractAPI } from './AbstractApi';
 const basePath = '/api_keys';
+type GetAPIKeyListParams = ClerkPaginationRequest<{
+ /**
+ * The user or organization ID to query API keys by
+ */
+ subject: string;
+ /**
+ * Whether to include invalid API keys.
+ *
+ * @default false
+ */
+ includeInvalid?: boolean;
+}>;
 type CreateAPIKeyParams = {
  type?: 'api_key';
  /**
  * API key name
  */
  name: string;
  /**
- * user or organization ID the API key is associated with
+ * The user or organization ID to associate the API key with
  */
  subject: string;
  /**
@@ Expand All / @@ -36,6 +51,14 @@ type RevokeAPIKeyParams = { @@
 };
 export class APIKeysAPI extends AbstractAPI {
+ async list(queryParams: GetAPIKeyListParams) {
+ return this.request<APIKey[]>({
+ method: 'GET',
+ path: basePath,
+ queryParams,
+ });
+ }
  async create(params: CreateAPIKeyParams) {
  return this.request<APIKey>({
  method: 'POST',
@@ Expand Down @@

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+---
+"@clerk/backend": patch
+---
+Added API keys list method to the backend SDK client

-Original file line number
+Diff line change
@@ -1,17 +1,32 @@
+import type { ClerkPaginationRequest } from '@clerk/types';
 import { joinPaths } from '../../util/path';
 import type { APIKey } from '../resources/APIKey';
 import { AbstractAPI } from './AbstractApi';
 const basePath = '/api_keys';
+type GetAPIKeyListParams = ClerkPaginationRequest<{
+ /**
+ * The user or organization ID to query API keys by
+ */
+ subject: string;
+ /**
+ * Whether to include invalid API keys.
+ *
+ * @default false
+ */
+ includeInvalid?: boolean;
+}>;
 type CreateAPIKeyParams = {
  type?: 'api_key';
  /**
  * API key name
  */
  name: string;
  /**
- * user or organization ID the API key is associated with
+ * The user or organization ID to associate the API key with
  */
  subject: string;
  /**
@@ Expand All / @@ -36,6 +51,14 @@ type RevokeAPIKeyParams = { @@
 };
 export class APIKeysAPI extends AbstractAPI {
+ async list(queryParams: GetAPIKeyListParams) {
+ return this.request<APIKey[]>({
+ method: 'GET',
+ path: basePath,
+ queryParams,
+ });
+ }
  async create(params: CreateAPIKeyParams) {
  return this.request<APIKey>({
  method: 'POST',
@@ Expand Down @@

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+---
+"@clerk/backend": patch
+---
+Added API keys list method to the backend SDK client

Uh oh!

chore(backend): Add API keys list method#6948

Uh oh!

chore(backend): Add API keys list method #6948

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

coderabbitaiBotOct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chore(backend): Add API keys list method#6948

Uh oh!

chore(backend): Add API keys list method #6948

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

coderabbitaiBotOct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chore(backend): Add API keys list method#6948

Uh oh!

chore(backend): Add API keys list method #6948

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

coderabbitaiBotOct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chore(backend): Add API keys list method#6948

Uh oh!

chore(backend): Add API keys list method #6948

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

coderabbitaiBotOct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chore(backend): Add API keys list method#6948

Uh oh!

chore(backend): Add API keys list method #6948

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

coderabbitaiBotOct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chore(backend): Add API keys list method#6948

Uh oh!

chore(backend): Add API keys list method #6948

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

coderabbitaiBotOct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chore(backend): Add API keys list method#6948