Add documentation for password reset enforcer#6038
Open
NipuniBhagya wants to merge 5 commits intowso2:masterfrom
Open
Add documentation for password reset enforcer#6038NipuniBhagya wants to merge 5 commits intowso2:masterfrom
NipuniBhagya wants to merge 5 commits intowso2:masterfrom
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughIntroduces an Asgardeo-only "Enforce password expiry for" selector in rule-based password expiration (All application login flows vs Selected application login flows), documents enforcing expiry per application via the Password Reset Enforcer, adds an adaptive script example for post-reset re-authentication, and renumbers steps accordingly. Changes
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`:
- Line 46: Replace the word "that" with "who" in the sentence "Set a default
password expiry rule that applies to any user that does not meet the custom
criteria." so it reads "Set a default password expiry rule that applies to any
user who does not meet the custom criteria."; locate this sentence in the
login-security/password-validation.md content and update the pronoun to "who" to
follow the plain-language guideline.
- Around line 52-57: The admonition bodies for the `!!! note` and `!!! tip`
blocks are not indented, so move the paragraph lines under each admonition to be
indented (e.g., prefix with two spaces) so they are nested inside the `!!! note`
and `!!! tip` blocks; target the `!!! note` and `!!! tip` markers in
password-validation.md and indent the subsequent explanatory lines to fix
rendering.
In `@en/includes/guides/user-accounts/account-security/password-validation.md`:
- Line 34: Replace "that" with "who" in the sentence "Set a default password
expiry rule that applies to any user that does not meet the custom criteria." so
it reads "Set a default password expiry rule that applies to any user who does
not meet the custom criteria." Locate this exact sentence in the document
(password-validation.md) and update the wording to use "who" for person-first
phrasing while keeping the rest of the sentence unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5edbe26e-734a-4bd5-995d-744948688b33
📒 Files selected for processing (2)
en/includes/guides/account-configurations/login-security/password-validation.mden/includes/guides/user-accounts/account-security/password-validation.md
en/includes/guides/account-configurations/login-security/password-validation.md
Outdated
Show resolved
Hide resolved
en/includes/guides/account-configurations/login-security/password-validation.md
Outdated
Show resolved
Hide resolved
| - **All organization users** (default): Enforces password expiry for all users upon login, regardless of which application they sign in to. | ||
| - **Specific application login flows**: Enforces password expiry only when users sign in to applications where password expiry has been enabled in the login flow. | ||
|
|
||
| 3. Set a default password expiry rule that applies to any user that does not meet the custom criteria. |
Contributor
There was a problem hiding this comment.
Use “who” for people
Line 34 should use “who” instead of “that” for person-first wording.
✏️ Proposed fix
-3. Set a default password expiry rule that applies to any user that does not meet the custom criteria.
+3. Set a default password expiry rule that applies to any user who does not meet the custom criteria.As per coding guidelines: "Use plain language and short sentences."
📝 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.
Suggested change
| 3. Set a default password expiry rule that applies to any user that does not meet the custom criteria. | |
| 3. Set a default password expiry rule that applies to any user who does not meet the custom criteria. |
🧰 Tools
🪛 LanguageTool
[style] ~34-~34: Consider using “who” when you are referring to a person instead of an object.
Context: ...rd expiry rule that applies to any user that does not meet the custom criteria. 4. ...
(THAT_WHO)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/guides/user-accounts/account-security/password-validation.md` at
line 34, Replace "that" with "who" in the sentence "Set a default password
expiry rule that applies to any user that does not meet the custom criteria." so
it reads "Set a default password expiry rule that applies to any user who does
not meet the custom criteria." Locate this exact sentence in the document
(password-validation.md) and update the wording to use "who" for person-first
phrasing while keeping the rest of the sentence unchanged.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
en/includes/guides/account-configurations/login-security/password-validation.md (1)
75-75:⚠️ Potential issue | 🟡 MinorUse “who” for people
Line 75 should use “who” instead of “that” in “any user that does not meet…”.
✏️ Suggested edit
-3. Set a default password expiry rule that applies to any user that does not meet the custom criteria. +3. Set a default password expiry rule that applies to any user who does not meet the custom criteria.As per coding guidelines: “Use plain language and short sentences.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/account-configurations/login-security/password-validation.md` at line 75, Update the sentence "Set a default password expiry rule that applies to any user that does not meet the custom criteria." to use "who" for people: change "any user that does not meet the custom criteria" to "any user who does not meet the custom criteria" so the sentence reads "Set a default password expiry rule that applies to any user who does not meet the custom criteria."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`:
- Around line 44-45: Replace all instances of "sign in" with the
repository-standard verb "log in" in the two bullet descriptions for **All
application login flows** and **Selected application login flows** so the text
reads "upon log in" and "when users log in to applications" (and also update the
other occurrence mentioned at lines 53-53) to ensure consistent use of "log in"
(verb) and "login" (noun/adjective) across the doc.
- Line 48: Update the link in the sentence that starts "To enforce password
expiry for a specific application, add the Password Reset Enforcer..." so it
points directly to the task-oriented guide for configuring an application's
login flow with the Password Reset Enforcer (replace the broad "Configure login
flows" link target and anchor text with a specific "Configure an application's
login flow" or "Add Password Reset Enforcer to an application login flow" page);
locate the sentence containing "Password Reset Enforcer" in
password-validation.md and change the href and link text to the specific task
page that shows how to add the Password Reset Enforcer to an application's login
flow.
---
Duplicate comments:
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`:
- Line 75: Update the sentence "Set a default password expiry rule that applies
to any user that does not meet the custom criteria." to use "who" for people:
change "any user that does not meet the custom criteria" to "any user who does
not meet the custom criteria" so the sentence reads "Set a default password
expiry rule that applies to any user who does not meet the custom criteria."
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c7306ece-888f-4e14-adb3-928596b8f0c7
⛔ Files ignored due to path filters (2)
en/asgardeo/docs/assets/img/guides/organization/account-security/password-validation/password-expiration.pngis excluded by!**/*.pngen/asgardeo/docs/assets/img/guides/organization/account-security/password-validation/password-expiry-reset-enforcer.pngis excluded by!**/*.png
📒 Files selected for processing (1)
en/includes/guides/account-configurations/login-security/password-validation.md
en/includes/guides/account-configurations/login-security/password-validation.md
Outdated
Show resolved
Hide resolved
| - **Selected application login flows**: Enforces password expiry only when users sign in to applications where password expiry has been enabled in the login flow. When selected, organization-wide password expiry enforcement is disabled. | ||
|
|
||
| !!! info | ||
| To enforce password expiry for a specific application, add the Password Reset Enforcer as an authentication step in the application's login flow. See [Configure login flows]({{base_path}}/guides/authentication/) for instructions. |
Contributor
There was a problem hiding this comment.
Make the per-application setup link more task-directed
Line 48 points to a broad authentication overview. For this step, readers need a direct path to configure an application login flow with Password Reset Enforcer; otherwise the instruction is hard to execute.
As per coding guidelines: “Task-based documentation must follow a logical, goal-oriented structure” and links should support actionable completion.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`
at line 48, Update the link in the sentence that starts "To enforce password
expiry for a specific application, add the Password Reset Enforcer..." so it
points directly to the task-oriented guide for configuring an application's
login flow with the Password Reset Enforcer (replace the broad "Configure login
flows" link target and anchor text with a specific "Configure an application's
login flow" or "Add Password Reset Enforcer to an application login flow" page);
locate the sentence containing "Password Reset Enforcer" in
password-validation.md and change the href and link text to the specific task
page that shows how to add the Password Reset Enforcer to an application's login
flow.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
en/includes/guides/account-configurations/login-security/password-validation.md (1)
18-18:⚠️ Potential issue | 🟡 MinorRemove trailing spaces.
Line 18 has 4 trailing spaces, which violates Markdown formatting rules. Remove them to fix the linting failure.
🧹 Proposed fix
- {: width="400" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + {: width="400" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/account-configurations/login-security/password-validation.md` at line 18, Remove the 4 trailing spaces in the Markdown file password-validation.md on the affected line (the blank/paragraph at line 18) so the line ends with no extra whitespace; simply delete the trailing spaces and save the file to resolve the linting failure.
♻️ Duplicate comments (1)
en/includes/guides/account-configurations/login-security/password-validation.md (1)
48-48:⚠️ Potential issue | 🟠 MajorThe link to "Configure login flows" is too broad for this task.
This line instructs users to add the Password Reset Enforcer to an application's login flow, but the link points to a general authentication overview. Readers need a direct path to the specific procedure for adding an authenticator to an application login flow to complete this task.
As per coding guidelines: "Task-based documentation must follow a logical, goal-oriented structure" and "Use descriptive link text for internal links and prefer linking to canonical pages."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/account-configurations/login-security/password-validation.md` at line 48, Replace the broad "Configure login flows" link with a direct, canonical page that outlines how to add an authenticator to an application's login flow; update the link text to something descriptive like "Add an authenticator to an application's login flow" and ensure it points to the specific procedure for adding the Password Reset Enforcer (referencing the "Password Reset Enforcer" phrase and the existing link text "Configure login flows" to locate the line to change).
🧹 Nitpick comments (1)
en/includes/guides/account-configurations/login-security/password-validation.md (1)
48-48: Format "Password Reset Enforcer" as a UI element."Password Reset Enforcer" is a specific authenticator feature and should be formatted in bold to match the treatment of other UI elements and features in the documentation.
🎨 Proposed formatting fix
- To enforce password expiry for a specific application, add the Password Reset Enforcer as an authentication step in the application's login flow. See [Configure login flows]({{base_path}}/guides/authentication/) for instructions. + To enforce password expiry for a specific application, add the **Password Reset Enforcer** as an authentication step in the application's login flow. See [Configure login flows]({{base_path}}/guides/authentication/) for instructions.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/account-configurations/login-security/password-validation.md` at line 48, Update the documentation sentence that mentions the specific authenticator by formatting the phrase "Password Reset Enforcer" as a UI element (bold) to match other feature names; locate the sentence that reads "To enforce password expiry for a specific application, add the Password Reset Enforcer as an authentication step..." and change only the visual formatting of the token "Password Reset Enforcer" to bold while keeping the rest of the text unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`:
- Around line 75-77: Rename the numbered list items in password-validation.md so
that when the Asgardeo-only block is omitted the sequence reads 1,2,3 (change
the current "3. Set a default..." to "2." and "4. Click Add Rule..." to "3.");
wrap the numbers in the existing Jinja conditional logic so that if the Asgardeo
block is present they render as 3 and 4 and otherwise as 2 and 3, and also
replace the word "subsequent" with "Each" in the "Click **Add Rule**" sentence
to address the Vale warning.
---
Outside diff comments:
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`:
- Line 18: Remove the 4 trailing spaces in the Markdown file
password-validation.md on the affected line (the blank/paragraph at line 18) so
the line ends with no extra whitespace; simply delete the trailing spaces and
save the file to resolve the linting failure.
---
Duplicate comments:
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`:
- Line 48: Replace the broad "Configure login flows" link with a direct,
canonical page that outlines how to add an authenticator to an application's
login flow; update the link text to something descriptive like "Add an
authenticator to an application's login flow" and ensure it points to the
specific procedure for adding the Password Reset Enforcer (referencing the
"Password Reset Enforcer" phrase and the existing link text "Configure login
flows" to locate the line to change).
---
Nitpick comments:
In
`@en/includes/guides/account-configurations/login-security/password-validation.md`:
- Line 48: Update the documentation sentence that mentions the specific
authenticator by formatting the phrase "Password Reset Enforcer" as a UI element
(bold) to match other feature names; locate the sentence that reads "To enforce
password expiry for a specific application, add the Password Reset Enforcer as
an authentication step..." and change only the visual formatting of the token
"Password Reset Enforcer" to bold while keeping the rest of the text unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 8ceac688-39dc-424c-969a-746f9d3f91c3
📒 Files selected for processing (1)
en/includes/guides/account-configurations/login-security/password-validation.md
en/includes/guides/account-configurations/login-security/password-validation.md
Outdated
Show resolved
Hide resolved
| @@ -38,9 +38,43 @@ To configure rule-based password expiration, | |||
|
|
|||
| 1. Turn the **Password Expiration** toggle on to enable password expiration. | |||
|
|
|||
| 2. Set a default password expiry rule that applies to any user that does not meet the custom criteria. | |||
| {% if product_name == "Asgardeo" %} | |||
| 2. In the **Enforce password expiry for** field, select who the password expiry policy applies to: | |||
Contributor
There was a problem hiding this comment.
Suggested change
| 2. In the **Enforce password expiry for** field, select who the password expiry policy applies to: | |
| 2. Select the users to whom the password expiry policy should apply using the **Enforce password expiry for** field.: |
| {% if product_name == "Asgardeo" %} | ||
| 2. In the **Enforce password expiry for** field, select who the password expiry policy applies to: | ||
|
|
||
| - **All application login flows** (default): Enforces password expiry for all users upon login, regardless of which application they log in to. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **All application login flows** (default): Enforces password expiry for all users upon login, regardless of which application they log in to. | |
| - **All application login flows**: Applies the password expiry policy to all users during login, regardless of the application they access. This is the default behavior. |
| 2. In the **Enforce password expiry for** field, select who the password expiry policy applies to: | ||
|
|
||
| - **All application login flows** (default): Enforces password expiry for all users upon login, regardless of which application they log in to. | ||
| - **Selected application login flows**: Enforces password expiry only when users log in to applications where password expiry has been enabled in the login flow. When selected, organization-wide password expiry enforcement is disabled. |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Selected application login flows**: Enforces password expiry only when users log in to applications where password expiry has been enabled in the login flow. When selected, organization-wide password expiry enforcement is disabled. | |
| - **Selected application login flows**: Enforces password expiry only when users log in to applications that have enabled this in the login flow. Selecting this option disables organization-wide password expiry enforcement.. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Purpose
This pull request updates the documentation for configuring rule-based password expiration to clarify how password expiry enforcement can be targeted to all organization users or only to specific application login flows. It also adds helpful notes and tips to guide users through the configuration process.
Documentation improvements for password expiration configuration:
account-configurations/login-security/password-validation.mdanduser-accounts/account-security/password-validation.md. [1] [2]Related Issue
Test environment
Security checks