Skip to content

docs: document upstream MFA carry-over for OIDC social sign-in#2507

Open
hperl wants to merge 3 commits intomasterfrom
feat/oidc-upstream-mfa-carryover
Open

docs: document upstream MFA carry-over for OIDC social sign-in#2507
hperl wants to merge 3 commits intomasterfrom
feat/oidc-upstream-mfa-carryover

Conversation

@hperl
Copy link
Copy Markdown
Member

@hperl hperl commented Apr 13, 2026

Summary

Documents the new upstream OIDC acr / amr carry-over feature shipped in ory-corp/cloud#11499.

When a user signs in through a social sign-in provider that already enforces MFA, Ory can now trust the upstream factor instead of asking the user to complete a second factor again. This PR adds:

  • A new page Upstream MFA carry-over (docs/kratos/social-signin/93_upstream-mfa.mdx) covering:
    • How Ory reads the upstream acr / amr claims and decides the resulting session AAL.
    • A provider support matrix (Generic OIDC, Auth0, Okta, Keycloak, Microsoft Entra v1, Ping Identity, Google, Apple, and others).
    • Console and CLI configuration examples for aal2_acr_values and aal2_amr_values.
    • How to ask the upstream provider for a specific acr value via acr_values or requested_claims.
    • A sample /sessions/whoami payload showing the new upstream_acr / upstream_amr audit fields.
    • Troubleshooting tips for empty upstream claims and accidental AAL2 elevation.
  • A short cross-link section on the Dynamic Multi-Factor Authentication page so customers enforcing AAL2 discover the option.
  • A sidebar entry for the new page under OpenID Connect SSO.

Test plan

  • npx prettier --check passes for changed files
  • Local docusaurus build (npm run build) — please verify in CI

Related

  • ory-corp/cloud#11499 — implementation PR
  • ory-corp/cloud#11494 — issue

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added documentation for upstream multi-factor authentication in social sign-in workflows under OpenID Connect SSO resources.

Copy link
Copy Markdown
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small formatting changes

Comment thread docs/kratos/social-signin/93_upstream-mfa.mdx Outdated
Comment thread docs/kratos/social-signin/93_upstream-mfa.mdx Outdated
Comment thread docs/kratos/social-signin/93_upstream-mfa.mdx Outdated
Comment thread docs/kratos/social-signin/93_upstream-mfa.mdx Outdated
Comment thread docs/kratos/social-signin/93_upstream-mfa.mdx
hperl and others added 2 commits April 28, 2026 09:24
Adds a new page describing how Ory carries over upstream OIDC `acr` and
`amr` claims into the resulting Ory session. Operators can configure
per-provider `aal2_acr_values` and `aal2_amr_values` allowlists to mark
sessions as AAL2 when the upstream identity provider has already
performed multi-factor authentication.

The new page covers:

- How Ory reads the upstream `acr` / `amr` claims and decides the
  session AAL.
- A provider support matrix (Generic OIDC, Auth0, Okta, Keycloak,
  Microsoft Entra v1, Ping Identity, Google, Apple, and others).
- Console and CLI configuration examples.
- How to ask the upstream provider for a specific `acr` value via
  `acr_values` or `requested_claims`.
- Sample `/sessions/whoami` payload showing the new `upstream_acr` /
  `upstream_amr` audit fields.
- Troubleshooting tips for empty upstream claims and accidental AAL2
  elevation.

The Dynamic MFA / step-up authentication doc gains a short section that
links to the new page so customers enforcing AAL2 discover the option.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 28, 2026 07:25
@hperl hperl force-pushed the feat/oidc-upstream-mfa-carryover branch from 34dd9c9 to e491eb7 Compare April 28, 2026 07:25
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 957d953a-21e1-4234-87b4-38f591c8f650

📥 Commits

Reviewing files that changed from the base of the PR and between 8134465 and e491eb7.

⛔ Files ignored due to path filters (2)
  • docs/kratos/mfa/05_step-up-authentication.mdx is excluded by !**/*.mdx
  • docs/kratos/social-signin/93_upstream-mfa.mdx is excluded by !**/*.mdx
📒 Files selected for processing (1)
  • src/sidebar-old.ts

📝 Walkthrough

Walkthrough

A new documentation page link, "kratos/social-signin/upstream-mfa", is added to the OpenID Connect SSO sidebar category within the documentation configuration, inserted among related social sign-in documentation references.

Changes

Cohort / File(s) Summary
OpenID Connect SSO Sidebar Configuration
src/sidebar-old.ts
Added new documentation page reference kratos/social-signin/upstream-mfa to the oidcSSO category under OpenID Connect SSO items.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • aeneasr
  • unatasha8

Poem

🐰 A link to upstream-mfa is here,
In the sidebar, crisp and clear,
Documentation grows with care,
For SSO, beyond compare!
One line added, knowledge shared,
With love, the docs are all prepared! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding documentation for upstream MFA carry-over functionality in OIDC social sign-in, which directly corresponds to the PR's primary objective.
Description check ✅ Passed The description includes a comprehensive summary, clear explanation of the feature, detailed breakdown of changes, test plan with checkmarks, and related issue references. It fully addresses the template requirements for documentation improvements.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/oidc-upstream-mfa-carryover

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

upstream Issue is caused by an upstream dependency.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants