Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/oauth-idtoken-member.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/backend": patch
---

Add optional `idToken` member to `OauthAccessToken` returned by `getUserOauthAccessToken`. The ID token is retrieved from OIDC providers and is only present for OIDC-compliant OAuth 2.0 providers when available.
2 changes: 2 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,8 @@ export interface OauthAccessTokenJSON {
// Only set in OAuth 1.0 tokens
token_secret?: string;
expires_at?: number;
// Only present for OIDC-compliant OAuth 2.0 providers when available
id_token?: string;
}

export interface OAuthApplicationJSON extends ClerkResourceJSON {
Expand Down
6 changes: 6 additions & 0 deletions packages/backend/src/api/resources/OauthAccessToken.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ export class OauthAccessToken {
readonly scopes?: string[],
readonly tokenSecret?: string,
readonly expiresAt?: number,
/**
* The ID token retrieved from the OIDC provider.
* Only present for OIDC-compliant OAuth 2.0 providers when available.
*/
readonly idToken?: string,
) {}

static fromJSON(data: OauthAccessTokenJSON) {
Expand All @@ -22,6 +27,7 @@ export class OauthAccessToken {
data.scopes,
data.token_secret,
data.expires_at,
data.id_token,
);
}
}