Skip to content

chore(backend): Add optional secret property in api key response #6246

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 2 commits into from
Jul 3, 2025
Merged

chore(backend): Add optional secret property in api key response #6246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
607377e
chore(backend): Add optional secret property in api key response
wobsoriano Jul 2, 2025
a25954e
chore: add changeset
wobsoriano Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/hungry-chairs-shake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/backend": patch
---

Add optional `secret` property in API key response
2 changes: 2 additions & 0 deletions packages/backend/src/api/resources/APIKey.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export class APIKey {
readonly lastUsedAt: number | null,
readonly createdAt: number,
readonly updatedAt: number,
readonly secret?: string,
Copy link
Contributor

@panteliselef panteliselef Jul 3, 2025

Choose a reason for hiding this comment

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

Why not

Suggested change
readonly secret?: string,
readonly secret: string | null,

Copy link
Member Author

@wobsoriano wobsoriano Jul 3, 2025

Choose a reason for hiding this comment

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

This was kind of tricky since only the create method actually returns a secret property. The rest does not. So adding null I think is not ideal here 👀

We'll definitely improve this along the way

) {}

static fromJSON(data: APIKeyJSON) {
Expand All @@ -36,6 +37,7 @@ export class APIKey {
data.last_used_at,
data.created_at,
data.updated_at,
data.secret,
);
}
}
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,7 @@ export interface APIKeyJSON extends ClerkResourceJSON {
object: typeof ObjectType.ApiKey;
type: string;
name: string;
secret?: string;
subject: string;
scopes: string[];
claims: Record<string, any> | null;
Expand Down