[RORDEV-2134] Improve impersonation docs

[mgoworko]

Summary by CodeRabbit

• Documentation
  • Added release notes for version 1.70.3, including security fixes, compatibility updates, and reliability improvements.
  • Expanded impersonation guidance with authentication flows, configuration requirements, examples, supported scenarios, and troubleshooting information.
  • Clarified usage counters, report permissions, startup behavior, and settings fallback changes in the release documentation.

[coderabbitai]

Warning

Review limit reached

@mgoworko, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 36beff41-6e41-4187-abc7-3dfb0e635e54

📥 Commits

Reviewing files that changed from the base of the PR and between 36e81cf and 3993b5b.

📒 Files selected for processing (1)

• details/impersonation.md

📝 Walkthrough

Walkthrough

The PR adds ROR 1.70.3 release notes and expands impersonation documentation with request-flow details, validation rules, supported authentication rules, examples, troubleshooting guidance, and glossary updates.

Changes

Release and impersonation documentation

Layer / File(s)	Summary
ROR 1.70.3 release notes changelog.md, changelog/1.70.3.yaml	Adds ROR 1.70.3 release details, security fixes, supported Kibana and Elasticsearch versions, and behavior fixes. Updates ROR 1.70.2 descriptions.
Impersonation model and validation details/impersonation.md	Documents identity matching, request processing, Test Settings requirements, configuration validation, failure codes, and rule support.
Impersonation examples and troubleshooting details/impersonation.md	Adds local-user and LDAP examples, mock requirements, troubleshooting cases, and an impersonated-user glossary definition.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• beshu-tech/readonlyrest-docs#269: Updates overlapping Kibana and Elasticsearch support-version documentation.
• beshu-tech/readonlyrest-docs#311: Also expands impersonation configuration documentation.

Suggested reviewers: coutopl

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the primary change: expanding the impersonation documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch RORDEV-2134

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@changelog.md`:
- Line 5: Update the “What’s new in ROR 1.70.3” heading in changelog.md from an
h3 (`###`) to an h2 (`##`) so the Markdown heading hierarchy is valid.

In `@details/impersonation.md`:
- Around line 50-61: Clarify the impersonation flow in the steps around
authentication-rule dispatch: supported authentication rules must skip their
normal authentication logic and enter impersonation handling, while still
enforcing each rule type’s impersonation support and required mock dependencies.
Remove the claim that all authentication rule types behave identically or that
the type is entirely irrelevant, and preserve the documented unsupported
behavior for jwt_* and ror_kbn_* rules and mock-dependent behavior for
LDAP/external rules.
- Around line 232-238: Update the LDAP impersonation documentation around the
impersonation example to distinguish the two identities: state that ldap1
authenticates impersonator admin1, whose credentials must be available through
auth_key, an LDAP password, or another supported impersonation rule, then
separately state that the dev2 Test Settings mock must define dev2 with LDAP
identity and devs group membership for the LDAP ACL checks.

🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ac3a1f94-d89a-42b0-ba4e-79cbea71cbcf

📥 Commits

Reviewing files that changed from the base of the PR and between 9116139 and 36e81cf.

📒 Files selected for processing (3)

• changelog.md
• changelog/1.70.3.yaml
• details/impersonation.md

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Restore the Markdown heading hierarchy.

The linter reports that Line [5] should use an h2 heading. Change ### to ##, or restore the missing parent heading.

Proposed fix

-### (2026-07-12) What's new in **ROR 1.70.3**
+## (2026-07-12) What's new in **ROR 1.70.3**

📝 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

	### (2026-07-12) What's new in **ROR 1.70.3**
	## (2026-07-12) What's new in **ROR 1.70.3**

🧰 Tools

🪛 markdownlint-cli2 (0.23.1)

[warning] 5-5: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@changelog.md` at line 5, Update the “What’s new in ROR 1.70.3” heading in
changelog.md from an h3 (`###`) to an h2 (`##`) so the Markdown heading
hierarchy is valid.

Source: Linters/SAST tools