(Can wait) Fix/Add note about token issues #308
Conversation
This file contains 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
WalkthroughThe pull request updates the documentation for ID tokens in the Kinde platform, specifically adding a new section that explains how to handle missing claims in tokens. The new content provides guidance for developers on ensuring they request the correct scopes when working with ID tokens, particularly for those not using an SDK. The addition aims to help users understand why certain claims might be absent and how to resolve such issues. Changes
Suggested reviewers
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/content/docs/build/tokens/about-id-tokens.mdx (1)
67-69: Enhance the scope-to-claim mapping information.The new section is valuable and addresses an important user pain point. Consider enhancing it with the following additions:
- Map specific scopes to their corresponding claims:
-Missing token claims are usually caused by missing scope requests in your app. If you are not using an SDK, you need to manually add scopes (such as `profile`, `email`, `openid`) so that the token you receive from Kinde includes the right claims. +Missing token claims are usually caused by missing scope requests in your app. If you are not using an SDK, you need to manually add scopes so that the token you receive from Kinde includes the right claims: +- `profile` scope: Grants access to `name`, `family_name`, `given_name`, and `picture` claims +- `email` scope: Grants access to the `email` claim +- `openid` scope: Required for OpenID Connect authentication flow
- Add a note about verifying configured scopes in the application settings.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/build/tokens/about-id-tokens.mdx(1 hunks)
🔇 Additional comments (1)
src/content/docs/build/tokens/about-id-tokens.mdx (1)
69-69: Verify the external documentation link and claims consistency.
Let's ensure the documentation is complete and consistent.
✅ Verification successful
External documentation link exists and claims are properly documented
The verification has confirmed:
- The referenced documentation at
/developer-tools/about/using-kinde-without-an-sdk/exists and contains comprehensive information about using Kinde without an SDK, including details about scopes. - The claims documentation in
about-id-tokens.mdxis complete and consistent:- All standard claims (
profile,email,openid) mentioned in the text are properly documented in the ID token standard claims section - The example token matches the documented claims
- Additional Kinde-specific claims are also documented
- All standard claims (
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the external documentation link and claims consistency
# Check if the referenced non-SDK documentation exists
echo "Checking for non-SDK documentation..."
fd --type f "using-kinde-without-an-sdk.mdx" src/content/docs/
# Check if all claims in the example are documented in the claims sections
echo "Checking claims documentation completeness..."
rg --type mdx "## (ID token standard claims|Kinde additional claims)" src/content/docs/build/tokens/about-id-tokens.mdx -A 20
Length of output: 474
Script:
#!/bin/bash
# Description: Verify the external documentation link and claims consistency
# Check if the referenced non-SDK documentation exists and its content
echo "Checking non-SDK documentation content..."
cat "src/content/docs/developer-tools/about/using-kinde-without-an-sdk.mdx"
# Check claims documentation completeness without file type specification
echo "Checking claims documentation completeness..."
rg "## (ID token standard claims|Kinde additional claims)" "src/content/docs/build/tokens/about-id-tokens.mdx" -A 20
Length of output: 13097
Deploying kinde-docs-previews with
|
| Latest commit: |
7c8cae0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ad830c9e.kinde-docs-previews.pages.dev |
| Branch Preview URL: | https://fix-missing-scopes-in-id-tok.kinde-docs-previews.pages.dev |
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.
A customer suggested we add a note to the ID tokens topic to handle case where non-SDK users are missing claims.
Summary by CodeRabbit