Documentation OIDC ID token #3032
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document that the user's OIDC ID Token (id_token) is also returned when available from the getUserOauthAccessToken() SDK function. Added a Returns section documenting all OauthAccessToken properties, with the idToken field noting that not all OAuth providers implement OIDC. Co-authored-by: jacob.foshee <[email protected]>
|
Cursor Agent can help with this pull request. Just |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Remove the #openid-connect-oidc anchor that wasn't being found due to how headings with parentheses are slugified. Link to the overview page directly instead. Co-authored-by: jacob.foshee <[email protected]>
SarahSoutoul
reviewed
Feb 3, 2026
9 tasks
Include all properties from the OauthAccessToken class: - publicMetadata: metadata readable from Frontend/Backend API - label: descriptive label for multiple tokens of same provider - expiresAt: Unix timestamp when token expires Also reordered properties to match the class definition order. Co-authored-by: jacob.foshee <[email protected]>
Contributor
|
I've pushed everything now, and happy with where this is at. @alexisintech you may want to have a look at this for final approval? |
Contributor
Author
|
Thanks @SarahSoutoul! This is much cleaner! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔎 Previews:
What does this solve?
id_token.getUserOauthAccessToken()SDK function did not explicitly mention that the OIDC ID Token (id_token) is also returned when available. (It's not obvious from the function name.) This update clarifies the full return value of the function.What changed?
docs/reference/backend/user/get-user-oauth-access-token.mdx.OauthAccessTokenobject, including theidToken?field.idToken?documentation specifies that it contains the user's OIDC ID Token (JWT) when the provider supports OIDC, and notes that it may beundefinedfor other providers.