-
Notifications
You must be signed in to change notification settings - Fork 376
Update the docs with new Extend expiry time of renewed refresh token application configuration.
#5813
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.
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
Update the docs with new Extend expiry time of renewed refresh token application configuration.
#5813
Conversation
WalkthroughAdded a new subsection to the OIDC settings documentation explaining that when the "extend expiry time" setting is false, renewed refresh tokens inherit the remaining validity period of the original refresh token. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md (1)
10-11: Clarify behavior for both enabled and disabled states.The documentation only describes the
falsestate but doesn't explain what happens when the setting istrue. Additionally, the phrasing differs from the nearby "Renew refresh token" section, which uses a more user-friendly pattern.For completeness, explain both states and consider aligning with the existing section's phrasing pattern to improve consistency and clarity.
🔎 Proposed documentation improvement
#### Extend expiry time of renewed refresh token -When this configuration is set to `false`, renewed refresh tokens carry the remaining validity period of the original refresh token. +If you enable this option, renewed refresh tokens will have their expiry time extended based on the configured refresh token expiry time. If you disable this option, renewed refresh tokens carry the remaining validity period of the original refresh token.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md (1)
10-13: Document both configuration states for clarity.The explanation only describes the behavior when
false. Users need to understand what happens when this setting istrue(presumably that renewed refresh tokens receive a new full expiry time). Consider revising to match the documentation pattern used in the "Renew refresh token" section above, which explains both the default and configured behavior.For example:
When this configuration is set to `false`, renewed refresh tokens carry the remaining validity period of the original refresh token. When set to `true`, renewed refresh tokens receive a new expiry time based on the configured refresh token expiry time.
Purpose
Test environment
Security checks
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.
Preview