Skip to content

chore: add TOTP, passkey, and WebAuthn credential import documentation#2512

Open
pi1814 wants to merge 1 commit intomasterfrom
chore/add-import-cred-docs
Open

chore: add TOTP, passkey, and WebAuthn credential import documentation#2512
pi1814 wants to merge 1 commit intomasterfrom
chore/add-import-cred-docs

Conversation

@pi1814
Copy link
Copy Markdown
Contributor

@pi1814 pi1814 commented Apr 16, 2026

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

Summary by CodeRabbit

Documentation

  • Updated importing credentials documentation to include TOTP, passkeys, and WebAuthn credential types.
  • Added detailed guidance on credential formats, field requirements, and import behaviors for each credential type.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

The PR updates documentation to include guidance on importing TOTP credentials, passkey credentials, and WebAuthn credentials for user account import procedures, alongside existing password and social sign-in credential documentation.

Changes

Cohort / File(s) Summary
Documentation - Credential Import Guide
docs/kratos/manage-identities/25_import-user-accounts-identities.mdx
Added sections documenting TOTP credential import (otpauth:// URLs), passkey credential import (base64-encoded binary fields, multiple per identity), and WebAuthn credential import (second-factor security keys), including configuration structure, field requirements, and update behavior for matching credentials.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description consists entirely of the template with no actual content filled in by the author; all sections remain as placeholder comments. Replace template placeholders with actual description of why these credential import docs are needed and any relevant context, even though documentation improvements don't require issue references.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for TOTP, passkey, and WebAuthn credential imports.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/add-import-cred-docs

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/kratos/manage-identities/25_import-user-accounts-identities.mdx`:
- Line 132: Update the overview sentence "Ory supports importing credentials for
identities including passwords, social sign-in connections, TOTP, and passkeys."
to also mention WebAuthn (e.g., add "WebAuthn" or "WebAuthn/passkeys") so the
list matches the later full WebAuthn import section; locate and edit that exact
sentence in the document to include WebAuthn in the credentials overview.
🪄 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 Plus

Run ID: 0d4b3c32-1a44-48df-9425-b6af3644ccdc

📥 Commits

Reviewing files that changed from the base of the PR and between 8daf6aa and f774821.

📒 Files selected for processing (1)
  • docs/kratos/manage-identities/25_import-user-accounts-identities.mdx

## Importing credentials

Ory supports importing credentials for identities including passwords and social sign-in connections.
Ory supports importing credentials for identities including passwords, social sign-in connections, TOTP, and passkeys.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Include WebAuthn in the credentials overview sentence.

Line 132 omits WebAuthn, but a full WebAuthn import section is added later. Please include it in the overview list to avoid a misleading summary.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/kratos/manage-identities/25_import-user-accounts-identities.mdx` at line
132, Update the overview sentence "Ory supports importing credentials for
identities including passwords, social sign-in connections, TOTP, and passkeys."
to also mention WebAuthn (e.g., add "WebAuthn" or "WebAuthn/passkeys") so the
list matches the later full WebAuthn import section; locate and edit that exact
sentence in the document to include WebAuthn in the credentials overview.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants