Conversation
WalkthroughThis pull request updates documentation for access tokens and ID tokens, focusing on enhancing the clarity and comprehensiveness of token-related information. The changes include adding new claims like "External provider ID" in access tokens and "Social identity" in ID tokens, while also refining existing claim descriptions. The modifications aim to provide more detailed insights into token characteristics, external provider integration, and user identity representation. Changes
Possibly related PRs
Suggested reviewers
Poem
Finishing Touches
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: 1
🔭 Outside diff range comments (1)
src/content/docs/build/tokens/about-id-tokens.mdx (1)
Line range hint
1-100: Fix incorrect description for "Updated at" claimThe description for the "Updated at" claim appears to be incorrectly copied from the "Issuer" claim. It should instead describe when the user's profile was last updated.
Apply this change:
-- **Updated at** - the `updated_at` claim specifies the issuer of the ID token, usually the URL of the authorization server or identity provider. It's used to verify the token's authenticity. ++ **Updated at** - the `updated_at` claim indicates the timestamp when the user's profile was last modified.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/content/docs/build/tokens/about-access-tokens.mdx(1 hunks)src/content/docs/build/tokens/about-id-tokens.mdx(1 hunks)
🔇 Additional comments (1)
src/content/docs/build/tokens/about-id-tokens.mdx (1)
36-36: LGTM: Social identity claim additionThe addition of the "Social identity" claim aligns well with the PR objectives and provides clear information about third-party profile details.
| - **External provider ID** - The ID you use to identify the organization the user is authorized against | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance documentation for External provider ID claim
While the addition of this claim aligns with the PR objectives, the documentation would benefit from additional details:
- What is the actual claim name/key in the token?
- How does this differ from or relate to the existing
org_codeclaim? - An example showing its usage in the example access token section would be helpful.
Consider expanding the documentation like this:
-- **External provider ID** - The ID you use to identify the organization the user is authorized against
++ **External provider ID** - The `ext_org_id` claim (or actual claim name) contains the identifier used to map the organization in external identity provider systems. This differs from `org_code` which is Kinde's internal organization identifier.Also, please add an example in the "Example access token" section showing this claim in use.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **External provider ID** - The ID you use to identify the organization the user is authorized against | |
| **External provider ID** - The `ext_org_id` claim (or actual claim name) contains the identifier used to map the organization in external identity provider systems. This differs from `org_code` which is Kinde's internal organization identifier. |
2 participants
Additional claims were not quite right in the Access and ID tokens docs.
Fixed by adding 'Social identity' for ID tokens and 'External provider ID' for Access tokens.
Summary by CodeRabbit
ext_from third-party enterprise authentication providers