Skip to content

docs: add Console OAuth/OIDC tutorial - #918

Open
rsdmike wants to merge 1 commit into
mainfrom
docs/console-oauth
Open

rsdmike wants to merge 1 commit into
mainfrom
docs/console-oauth

Conversation

@rsdmike

@rsdmike rsdmike commented Oct 23, 2026

Copy link
Copy Markdown
Member

PR Checklist

What are you changing?

Adds a tutorial for turning on OAuth 2.0 / OIDC in Console, aimed at ISVs replacing the default admin login:

  • How the mode switch works (auth.clientId), the token rules Console enforces (RS256 JWT, exact iss, aud contains auth.clientId)
  • Provider tabs: Microsoft Entra ID, Amazon Cognito (Pre token generation V2_0 trigger to add aud, strict discovery off), Keycloak (audience mapper), other providers
  • config.yml and environment variable examples, a settings reference, behaviour changes in OAuth mode, verification steps and troubleshooting

Also creates Tutorials > Authentication and moves the existing MPS tutorial there:

  • Tutorials/modifyUserAuth.md -> Tutorials/Authentication/modifyUserAuth.md (nav label "MPS User Authentication"), relative links and image paths updated
  • Tutorials overview and the AUTH_CLIENT_ID row in Console Configuration link to the new page

Anything the reviewer should know when reviewing this PR?

  • Content is based on Console main (config/config.go, internal/controller/httpapi/v1/login.go, internal/controller/httpapi/ui.go) and the Sample Web UI OAuth setup.
  • The old URL Tutorials/modifyUserAuth/ will 404 after publish since the site has no redirect plugin.
  • zensical build --strict passes locally. The IdP steps have not been run end to end against live Entra, Cognito or Keycloak tenants.

Copilot AI balanced review requested due to automatic review settings October 23, 2026 15:41

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.

🟡 Changes recommended

Provider setup and authentication behavior guidance contain inaccuracies that can block sign-in or mislead operators.

4 open issues
What changed in this PR

Adds a Console OAuth/OIDC tutorial and groups authentication guides together in the documentation.

Changes:

  • Documents provider setup, Console configuration, token requirements, verification, and troubleshooting.
  • Moves the MPS authentication tutorial under Authentication and adjusts its relative links and image paths.
  • Adds navigation and reference links to the new tutorial.
File Description
mkdocs.yml Groups both tutorials under Authentication.
docs/​Tutorials/​overview.md Introduces links to both authentication guides.
docs/​Tutorials/​Authentication/​modifyUserAuth.md Updates relative paths after relocation.
docs/​Tutorials/​Authentication/​consoleOAuth.md Adds the Console OAuth/OIDC setup guide.
docs/​Reference/​Console/​configuration.md Links AUTH_CLIENT_ID to the new tutorial.

Review effort: Balanced

Comment thread docs/Tutorials/Authentication/consoleOAuth.md Outdated
Comment thread docs/Tutorials/Authentication/consoleOAuth.md Outdated
Comment thread docs/Tutorials/Authentication/consoleOAuth.md Outdated
Comment thread docs/Tutorials/Authentication/consoleOAuth.md Outdated
@rsdmike
rsdmike force-pushed the docs/console-oauth branch 3 times, most recently from da09af7 to b3b399b Compare October 23, 2026 15:59
Groups it with the MPS user auth tutorial under Tutorials > Authentication.

Refs: device-management-toolkit/deployment#682
@rsdmike
rsdmike force-pushed the docs/console-oauth branch from b3b399b to f4a55db Compare October 23, 2026 16:06

This branch has not been deployed

No deployments
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