Skip to content

[DRAFT] EDFI-2882 Enable Auth0 Identity Provider Docs - #613

Draft
adiaz-msdf wants to merge 2 commits into
EDFI-2794_Identity_Provider_Entra_Googlefrom
EDFI-2882_Enable_Auth0_Identity_Provider
Draft

[DRAFT] EDFI-2882 Enable Auth0 Identity Provider Docs#613
adiaz-msdf wants to merge 2 commits into
EDFI-2794_Identity_Provider_Entra_Googlefrom
EDFI-2882_Enable_Auth0_Identity_Provider

Conversation

@adiaz-msdf

Copy link
Copy Markdown
Contributor

Summary

Documents Auth0 as the fourth validated identity provider for the Ed-Fi Admin
App, following the structure PR #562 established for Microsoft Entra ID and
Google Workspace. Builds on top of #562's restructured identity-provider layout.

New page

docs/reference/5-admin-app/configuration/identity-provider/auth0.md, mirroring
the Entra ID guide:

  • Part A — create the Single Page Web Application, register the callback /
    logout / web-origin URLs (with Auth0's exact field names), and the
    users-need-an-email requirement. Eight dashboard screenshots (hosted on the
    Ed-Fi docs blob storage).
  • Part B — the production.js SAMPLE_OIDC_CONFIG block and its
    differences from the Keycloak example (tenant-URL issuer without a trailing
    slash, explicit openid profile email scope).
  • Part CVITE_OIDC_ID and VITE_IDP_ACCOUNT_URL (Auth0 has no hosted
    end-user account page).
  • Part D — end-to-end validation plus a troubleshooting table
    (Invalid email from IdP, USER_NOT_FOUND, Auth0's "Callback URL mismatch"
    page, trailing-slash discovery failure).
  • Machine-to-machine — Auth0 API identifier = MACHINE_AUDIENCE, RFC 9068
    JWT profile (with the EDFI-2780 azp-fallback nuance), login:app
    permission, the mandatory audience token parameter, and a 401 decode
    checklist, cross-linked to the Quick Start appendix and the installation
    scripts repository.

Validation

  • Human login and the Global Admin Quick Start validated end-to-end against an
    Auth0 dev tenant on Windows/IIS using the companion scripts change
    (Ed-Fi-Exchange-OSS/Admin-App-Installation-Scripts, EDFI-2882 branch).
  • markdownlint-cli2: 0 errors on all touched files; all relative links and
    anchors resolve; all eight blob image URLs return HTTP 200.

Dependencies

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds Auth0 as a documented and “validated” OpenID Connect identity provider option for the Ed-Fi Admin App docs, extending the identity-provider documentation set introduced in PR #562 and updating installation/user-guide pages to reference Auth0 alongside Keycloak, Entra ID, and Google Workspace.

Changes:

  • Adds a new Auth0 identity provider guide (auth0.md) covering human login setup and M2M/API access configuration.
  • Updates getting-started and user-guide docs to include Auth0 in the list of validated providers and to link to the new guide.
  • Extends the Windows/IIS automated install examples to include an Auth0 (-IdpProvider auth0) walkthrough.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/reference/5-admin-app/user-guide/readme.md Updates validated IdP list to include Auth0.
docs/reference/5-admin-app/getting-started/windows-iis-installation/readme.md Notes Auth0 support in the Windows/IIS installation overview.
docs/reference/5-admin-app/getting-started/windows-iis-installation/manual.md Updates manual install IdP section to include Auth0 as an option.
docs/reference/5-admin-app/getting-started/windows-iis-installation/automated.md Adds an Auth0 automated-install example and updates -IdpProvider options list.
docs/reference/5-admin-app/getting-started/unix-installation.md Updates OIDC provider notes to include Auth0 and link to its guide.
docs/reference/5-admin-app/getting-started/readme.md Updates “validated providers” statements to include Auth0.
docs/reference/5-admin-app/getting-started/docker-installation.md Updates provider notes and VITE_IDP_ACCOUNT_URL guidance for Auth0.
docs/reference/5-admin-app/configuration/identity-provider/readme.md Adds Auth0 to the provider guide index and “validated providers” list.
docs/reference/5-admin-app/configuration/identity-provider/auth0.md New Auth0 setup guide (app registration, config snippets, validation, troubleshooting, M2M notes).
docs/reference/5-admin-app/configuration/configuring-admin-app.md Updates authentication overview text to include Auth0 as validated.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/reference/5-admin-app/configuration/identity-provider/auth0.md Outdated
Comment thread docs/reference/5-admin-app/configuration/identity-provider/auth0.md Outdated

@analiliagutierrez analiliagutierrez left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall Assessment

Well-structured guide that matches the existing identity-provider docs and, as tested, matches observed behavior: the trailing-slash handling and the troubleshooting table line up with what the install actually does. Human login is validated end to end on the v4.0.1 stable release, and M2M was validated separately.

Required Changes (MUST)

See the inline MUST on automated.md: the Auth0 example passes a -SaPassword parameter that install-all does not have, so it fails on copy-paste.

Comment thread docs/reference/5-admin-app/getting-started/windows-iis-installation/automated.md Outdated
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.

3 participants