Skip to content

docs: consolidate passkey docs and add embedded enrollment guide#1220

Open
tomauth0 wants to merge 1 commit into
auth0:mainfrom
tomauth0:pk-api-ga-updates
Open

docs: consolidate passkey docs and add embedded enrollment guide#1220
tomauth0 wants to merge 1 commit into
auth0:mainfrom
tomauth0:pk-api-ga-updates

Conversation

@tomauth0
Copy link
Copy Markdown
Contributor

  • Merge native-passkeys-api.mdx and native-passkeys-for-mobile-applications.mdx into passkey-apis.mdx ("Passkey APIs for Embedded Applications"). Cover iOS, Android, and web with platform-specific tabs for client-side credential APIs; defer parameter reference to the My Account API explorer instead of duplicating tables.

  • Correct app-association guidance: Auth0 hosts apple-app-site-association and assetlinks.json automatically based on Device Settings; developers do not host these files themselves.

  • Rewrite cross-platform guidance: synced credentials handle the common case (no QR code needed); hybrid transport is a fallback for cross-ecosystem or shared-device scenarios only. Avoid setting rpId at the eTLD+1; prefer a parent subdomain scoped to auth surfaces.

  • Add new Embedded Login Enrollment use case (authenticate/login/embedded-login/use-cases/enrollment.mdx) covering MFA factor enrollment, passkey enrollment, connected accounts, and self-service authentication method management.

  • Update embedded-login.mdx capabilities to mention native social login and broaden passkey support to web + iOS + Android.

  • Remove Early Access warnings from Passkey APIs and My Account API pages now that they are GA.

  • Add redirects from old passkey URLs to the consolidated page; update inbound links in passkeys.mdx, passwordless.mdx, my-account-api.mdx, and api/myaccount.mdx.

Description

References

Testing

Checklist

  • I've read and followed CONTRIBUTING.md.
  • I've tested the site build for this change locally.
  • I've made appropriate docs updates for any code or config changes.
  • I've coordinated with the Product Docs and/or Docs Management team about non-trivial changes.

  - Merge native-passkeys-api.mdx and native-passkeys-for-mobile-applications.mdx
    into passkey-apis.mdx ("Passkey APIs for Embedded Applications").
    Cover iOS, Android, and web with platform-specific tabs for client-side
    credential APIs; defer parameter reference to the My Account API
    explorer instead of duplicating tables.
  - Correct app-association guidance: Auth0 hosts apple-app-site-association
    and assetlinks.json automatically based on Device Settings; developers
    do not host these files themselves.
  - Rewrite cross-platform guidance: synced credentials handle the common
    case (no QR code needed); hybrid transport is a fallback for
    cross-ecosystem or shared-device scenarios only. Avoid setting rpId
    at the eTLD+1; prefer a parent subdomain scoped to auth surfaces.

  - Add new Embedded Login Enrollment use case
    (authenticate/login/embedded-login/use-cases/enrollment.mdx) covering
    MFA factor enrollment, passkey enrollment, connected accounts, and
    self-service authentication method management.

  - Update embedded-login.mdx capabilities to mention native social login
    and broaden passkey support to web + iOS + Android.

  - Remove Early Access warnings from Passkey APIs and My Account API
    pages now that they are GA.

  - Add redirects from old passkey URLs to the consolidated page; update
    inbound links in passkeys.mdx, passwordless.mdx, my-account-api.mdx,
    and api/myaccount.mdx.

  Note: fr-ca and ja-jp translations still reference the old structure
  and need a follow-up translation pass.
@tomauth0 tomauth0 requested review from a team as code owners May 19, 2026 14:10
Copy link
Copy Markdown
Contributor

@hazel-nut hazel-nut left a comment

Choose a reason for hiding this comment

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

looks like you have some merge conflicts and unverified commits you'll need to fix, and you'll need to add redirects for the pages you're deleting. 🙂 happy to review more fully for content afterwards!

@hazel-nut hazel-nut self-assigned this May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants