Skip to content

fix: complete auth API docs migration to Mintlify MDX#1199

Open
mikemimik wants to merge 14 commits into
mainfrom
fix/auth-api-docs-migration-completion
Open

fix: complete auth API docs migration to Mintlify MDX#1199
mikemimik wants to merge 14 commits into
mainfrom
fix/auth-api-docs-migration-completion

Conversation

@mikemimik
Copy link
Copy Markdown
Contributor

@mikemimik mikemimik commented May 14, 2026

Summary

  • Migrates Authentication API navigation from auto-generated JSON files to static navigation configs (en, fr-ca, ja-jp)
  • Extracts auth API navigation pages into dedicated api.authentication.{locale}.json files using $ref pattern
  • Adds URL redirects from old paths (including the muti-factor-authentication typo) to the new structure
  • Fixes the misspelled muti-factor-authentication directory by moving content to multi-factor-authentication (en)
  • Removes obsolete fr-ca and ja-jp files from the previous directory structure
  • Adds complete fr-ca (French-Canadian) Authentication API docs with proper Mintlify MDX components
  • Adds complete ja-jp (Japanese) Authentication API docs with proper Mintlify MDX components
  • All content uses <Note>, <ParamField>, and markdown tables per Mintlify conventions

Test plan

  • Run mint dev from main/ and verify Authentication API pages render correctly
  • Verify navigation sidebar shows all auth API endpoints for en, fr-ca, and ja-jp
  • Spot-check fr-ca pages (e.g., /docs/fr-ca/api/authentication, /docs/fr-ca/api/authentication/login) for French content
  • Spot-check ja-jp pages (e.g., /docs/ja-jp/api/authentication, /docs/ja-jp/api/authentication/login) for Japanese content
  • Verify redirects work (e.g., old /muti-factor-authentication/ paths redirect to /multi-factor-authentication/)
  • Verify $ref navigation loading works for the auth API section

🤖 Generated with Claude Code

@mikemimik mikemimik requested review from a team as code owners May 14, 2026 19:59
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 14, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
auth0 🟢 Ready View Preview May 14, 2026, 8:07 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

guessing this shouldn't remove the separated nav config files, right? :)

(reviewing because i saw it go by, but if this is still a WIP, swap to a draft?)

mikemimik and others added 10 commits May 14, 2026 18:45
…configs

Remove auto-generated authentication navigation JSON files and integrate
the navigation structure directly into the static en/fr-ca/ja-jp configs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add redirects from old authentication API URL paths to new structure,
including muti-factor-authentication typo paths and reorganized endpoints.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove the misspelled muti-factor-authentication directory and its files.
Content has been migrated to the correctly-spelled multi-factor-authentication
directory. Also removes obsolete _metadata.json.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add MFA endpoint documentation under the correctly-spelled
multi-factor-authentication directory with proper Mintlify MDX components.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove fr-ca authentication API files that used the old directory naming
and structure. Content has been reorganized under the new path structure
matching the English docs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update existing fr-ca authentication API MDX files with proper French-Canadian
translated content using Mintlify components (Note, ParamField, tables).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add French-Canadian authentication API documentation files matching the
new English directory structure. Includes login, logout, MFA, SAML,
passwordless, token flows, and legacy endpoints.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove ja-jp authentication API files that used the old directory naming
and structure. Content has been reorganized under the new path structure
matching the English docs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update existing ja-jp authentication API MDX files with proper Japanese
translated content using Mintlify components (Note, ParamField, tables).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Japanese authentication API documentation files matching the new
English directory structure. Includes login, logout, MFA, SAML,
passwordless, token flows, and legacy endpoints.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@mikemimik mikemimik force-pushed the fix/auth-api-docs-migration-completion branch from 6b6808d to 6dcb9d5 Compare May 14, 2026 22:47
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

Summary

Status Count
🔍 Total 533
✅ Successful 191
⏳ Timeouts 0
🔀 Redirected 19
👻 Excluded 282
❓ Unknown 0
🚫 Errors 40
⛔ Unsupported 1

Errors per input

Errors in main/docs/api/authentication/login/index.mdx

Errors in main/docs/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx

Errors in main/docs/fr-ca/api/authentication.mdx

Errors in main/docs/fr-ca/api/authentication/implicit-flow/authorize.mdx

Errors in main/docs/fr-ca/api/authentication/login/enterprise-saml-and-others.mdx

Errors in main/docs/fr-ca/api/authentication/login/index.mdx

Errors in main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx

Errors in main/docs/fr-ca/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx

Errors in main/docs/fr-ca/api/authentication/signup/create-a-new-user.mdx

Errors in main/docs/ja-jp/api/authentication.mdx

Errors in main/docs/ja-jp/api/authentication/account-linking-legacy/link.mdx

Errors in main/docs/ja-jp/api/authentication/change-password/change-password.mdx

Errors in main/docs/ja-jp/api/authentication/delegation-legacy/delegation.mdx

Errors in main/docs/ja-jp/api/authentication/login-legacy/database-ad-lapd-active.mdx

Errors in main/docs/ja-jp/api/authentication/login/authenticate-using-database.mdx

Errors in main/docs/ja-jp/api/authentication/login/enterprise-saml-and-others.mdx

Errors in main/docs/ja-jp/api/authentication/login/index.mdx

Errors in main/docs/ja-jp/api/authentication/login/start-back-channel-login.mdx

Errors in main/docs/ja-jp/api/authentication/logout/saml-logout.mdx

Errors in main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx

Errors in main/docs/ja-jp/api/authentication/revoke-refresh-token/revoke-refresh-token.mdx

Errors in main/docs/ja-jp/api/authentication/signup/create-a-new-user.mdx

Errors in main/docs/ja-jp/api/authentication/user-profile/get-user-info.mdx

Errors in main/docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request.mdx

Redirects per input

Redirects in main/docs/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx

Redirects in main/docs/fr-ca/api/authentication.mdx

Redirects in main/docs/fr-ca/api/authentication/custom-token-exchange/get-token.mdx

Redirects in main/docs/fr-ca/api/authentication/login-legacy/database-ad-lapd-active.mdx

Redirects in main/docs/fr-ca/api/authentication/login/authenticate-using-database.mdx

Redirects in main/docs/fr-ca/api/authentication/login/check-back-channel-login-status.mdx

Redirects in main/docs/fr-ca/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx

Redirects in main/docs/fr-ca/api/authentication/signup/create-a-new-user.mdx

Redirects in main/docs/fr-ca/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx

Redirects in main/docs/ja-jp/api/authentication.mdx

Redirects in main/docs/ja-jp/api/authentication/custom-token-exchange/get-token.mdx

Redirects in main/docs/ja-jp/api/authentication/login-legacy/social-with-providers-access-token.mdx

Redirects in main/docs/ja-jp/api/authentication/login/authenticate-using-database.mdx

Redirects in main/docs/ja-jp/api/authentication/login/check-back-channel-login-status.mdx

Redirects in main/docs/ja-jp/api/authentication/multi-factor-authentication/verify-mfa-with-otp.mdx

Redirects in main/docs/ja-jp/api/authentication/passwordless/get-code-or-link.mdx

Redirects in main/docs/ja-jp/api/authentication/token-exchange-for-native-social/token-exchange-native-social.mdx

Redirects in main/docs/ja-jp/api/authentication/ws-federation/accept-ws-federation-request.mdx

mikemimik and others added 2 commits May 14, 2026 19:03
Create api.authentication.{en,fr-ca,ja-jp}.json files containing the
Authentication API pages arrays, following the same pattern used by
Management API, My Account API, and My Organization API navigation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the inline pages arrays in en.json, fr-ca.json, and ja-jp.json
with $ref pointers to the newly created api.authentication.*.json files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@mikemimik
Copy link
Copy Markdown
Contributor Author

guessing this shouldn't remove the separated nav config files, right? :)

(reviewing because i saw it go by, but if this is still a WIP, swap to a draft?)

ℹ️ I've restructured the changes to use $ref and created files in a way that should not conflict with your IA in-progress work.

ℹ️ This work is mean to migrate the Auth API does as is from our v1 platform over to our v2 platform. The content will not be generated.

Match the pattern used by management.en.json where all sub-groups
are wrapped inside a { "group": " " } container for proper sidebar
rendering.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@mikemimik mikemimik self-assigned this May 14, 2026
@mikemimik mikemimik added the main-docs Changes related to auth0's main docs (https://auth0.com/docs) label May 14, 2026
…bar title

Mintlify derives sidebar labels from the path segment when a folder
path is used. Referencing login/index explicitly causes it to read
the frontmatter title ("Social") instead of showing "Login".

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
{
"group": "Login",
"pages": [
"docs/api/authentication/login/index",
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

ℹ️ It's necessary to do this /index bit to make Mintlify render the page title correctly in the sidebar. If we don't add /index the sidebar will say "Login" instead of "Social"

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

Labels

main-docs Changes related to auth0's main docs (https://auth0.com/docs)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants