[DRAFT] EDFI-2794 Document Entra ID and Google Workspace for Windows, Docker and Unix - #562
Draft
analiliagutierrez wants to merge 7 commits into
Draft
[DRAFT] EDFI-2794 Document Entra ID and Google Workspace for Windows, Docker and Unix#562analiliagutierrez wants to merge 7 commits into
analiliagutierrez wants to merge 7 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the Ed-Fi Admin App documentation to support multiple OpenID Connect identity providers by restructuring the identity-provider docs into a Docusaurus category and adding provider-specific setup guides for Microsoft Entra ID and Google Workspace, while updating surrounding Admin App docs to be IdP-agnostic (not Keycloak-only).
Changes:
- Restructured “Configuring an Identity Provider” into
configuration/identity-provider/with an overview page plus per-provider pages. - Added new setup/validation guides for Microsoft Entra ID and Google Workspace OIDC configuration.
- Updated Admin App getting-started and Windows/IIS guidance to reference the new provider guides and generalized IdP-specific guidance (e.g.,
VITE_IDP_ACCOUNT_URL).
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/5-admin-app/user-guide/readme.md | Updates login guidance to reference validated IdPs and link to the new IdP category. |
| docs/reference/5-admin-app/getting-started/windows-iis-installation/readme.md | Updates Windows/IIS prerequisites text and link to the new IdP docs location. |
| docs/reference/5-admin-app/getting-started/windows-iis-installation/manual.md | Updates IdP links to the new category path. |
| docs/reference/5-admin-app/getting-started/windows-iis-installation/automated.md | Adds Entra/Google install-all.ps1 examples and updates IdP links. |
| docs/reference/5-admin-app/getting-started/unix-installation.md | Updates “Next steps” link to the new IdP docs location. |
| docs/reference/5-admin-app/getting-started/readme.md | Generalizes authentication/provider language and updates IdP links. |
| docs/reference/5-admin-app/getting-started/docker-installation.md | Generalizes VITE_IDP_ACCOUNT_URL guidance across providers and updates IdP link. |
| docs/reference/5-admin-app/configuration/identity-provider/category.json | Introduces a Docusaurus category for provider-specific IdP docs. |
| docs/reference/5-admin-app/configuration/identity-provider/readme.md | New overview page describing the generic/table-driven OIDC model and linking to provider guides. |
| docs/reference/5-admin-app/configuration/identity-provider/keycloak.md | Rehomes Keycloak content under the new category and adjusts its sidebar ordering/title. |
| docs/reference/5-admin-app/configuration/identity-provider/microsoft-entra-id.md | New Entra-specific OIDC registration/config/validation guide. |
| docs/reference/5-admin-app/configuration/identity-provider/google-workspace.md | New Google Workspace OIDC registration/config/validation guide. |
| docs/reference/5-admin-app/configuration/configuring-admin-app.md | Updates authentication text and VITE_IDP_ACCOUNT_URL guidance to be provider-agnostic and links to the new IdP category. |
analiliagutierrez
force-pushed
the
EDFI-2794_Identity_Provider_Entra_Google
branch
from
July 20, 2026 18:26
d2e8e61 to
323a158
Compare
7 tasks
analiliagutierrez
force-pushed
the
EDFI-2779_Windows_Server_Installation_Guide
branch
from
July 30, 2026 03:18
feceb42 to
ad2b6b2
Compare
Base automatically changed from
EDFI-2779_Windows_Server_Installation_Guide
to
main
July 31, 2026 16:05
Restructure the single identity-provider reference page into a category: a parent overview (general IdP guidance, the table-driven configuration model, and links to each provider) plus one guide per provider. The Microsoft Entra ID and Google Workspace guides are new; the existing Keycloak content moves unchanged into its own page as the bundled default example.
Update the surrounding Admin App docs so they no longer read as Keycloak-only: present Keycloak as the bundled default example alongside Microsoft Entra ID and Google Workspace, generalize the VITE_IDP_ACCOUNT_URL guidance to all three providers, and repoint the moved identity-provider links to the new folder.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Adapt the Docker Compose and Unix-like install guides to the generic OIDC provider structure from EDFI-2794, keeping Keycloak as the bundled example. - Docker: add VITE_OIDC_ID to the .env example; add notes on pointing the API at a non-Keycloak provider (production.js-edfi + rebuild) and on the redirect/callback URI, with links to the Entra ID and Google guides. - Unix: mark SAMPLE_OIDC_CONFIG as the Keycloak example, fix its scope to "openid email profile", and add a provider note (config keys, callback URI, and the build-time VITE frontend variables), with the same links.
Use "openid email profile" as the Keycloak example scope in configuring-admin-app (config block and SQL insert) to match the Windows and Unix install guides, and reword the Entra ID and Google Workspace scope notes so they no longer assert the Keycloak example uses an empty scope.
…quisites Document the idp-entra-setup.ps1 helper as an automated alternative to the manual Entra App Registration (Part A of the Microsoft Entra ID guide), with a cross- reference from the automated Windows install guide. Also split the Entra directory-role prerequisites: Cloud Application Administrator to create the app, and Privileged Role Administrator / Global Administrator to grant admin consent.
analiliagutierrez
force-pushed
the
EDFI-2794_Identity_Provider_Entra_Google
branch
from
July 31, 2026 21:47
1c36d74 to
a1bfd33
Compare
The Windows/IIS installer has no -SaPassword parameter; SQL Server setup runs under Windows Authentication and never uses the sa login. The microsoft and google automated-install examples referenced it, so a copy-paste failed at parameter binding. Drop the line; -AppDbPassword remains.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Draft until Admin APP v4.1 is released.
Summary
Adds provider-specific OIDC setup guides for Microsoft Entra ID and Google Workspace, restructures "Configuring an Identity Provider" into a category (one page per provider), and makes the surrounding Admin App docs identity-provider agnostic so they no longer read as Keycloak-only. Also adapts the Docker Compose and Unix-like install guides to the same generic OIDC structure (EDFI-2851).
Tickets
Dependency
Based on the
EDFI-2779_Windows_Server_Installation_Guidebranch (PR #537), notmain— merge after #537. This branch builds on #537's Windows IIS guide restructure.The EDFI-2795 content documents the
idp-entra-setup.ps1helper, which ships in Admin-App-Installation-Scripts PR #5. Merge these docs together with that PR so the documented script exists when the guide references it (both target the Admin App v4.1 release).What changed
Identity provider docs restructured into a category (
configuration/identity-provider/):keycloak.md— the existing Keycloak content, moved unchanged, as the bundled default example.microsoft-entra-id.md— new: App Registration, client secret, API permissions, the requiredemailoptional claim, single-tenant vs. multitenant,production.jsand frontend configuration, end-to-end validation and triage.google-workspace.md— new: Google Cloud project, OAuth consent screen (Internal audience), OAuth client,production.jsand frontend configuration, end-to-end validation and triage.Made the surrounding Admin App docs identity-provider agnostic:
getting-started/readme,configuration/configuring-admin-app,user-guide/readme, and the Windows IIS pages).VITE_IDP_ACCOUNT_URLguidance to all three providers.install-all.ps1examples to the Windows IIS Automated page.idp-entra-setup.ps1helper (scripts PR #5) as an automated alternative to the manual Entra App Registration (a Part A tip), cross-referenced from the Automated install page; and split the Entra directory-role prerequisites (Cloud Application Administrator to create the app vs. Privileged Role Administrator / Global Administrator to grant admin consent).Docker and Unix-like install guides (EDFI-2851):
VITE_OIDC_IDto the.envexample; documented pointing the API at a non-Keycloak provider (production.js-edfi+./start-services.ps1 -Rebuild) and the deployment-specific redirect/callback URI.SAMPLE_OIDC_CONFIGas the Keycloak example, documented the callback URI and the build-timeVITE_OIDC_ID/VITE_IDP_ACCOUNT_URLfrontend variables.scopetoopenid email profileacross the configuration and install guides for consistency.Validation
markdownlintclean; Docusaurus build passes withonBrokenMarkdownLinks: 'throw'(no broken internal links or anchors); all 14 image URLs return 200.Screenshots