Skip to content

docs: add entra connect guide#1431

Open
nibalizer wants to merge 2 commits into
mainfrom
nibz/entra_connect_guide
Open

docs: add entra connect guide#1431
nibalizer wants to merge 2 commits into
mainfrom
nibz/entra_connect_guide

Conversation

@nibalizer

Copy link
Copy Markdown
Contributor

Pull Request Description

Adds docs on setting up an Entra tenant and adding it.

What and why?

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@github-actions

Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This PR updates the documentation to provide detailed guidance on configuring Single Sign-On (SSO) integration with Microsoft Entra ID (formerly Azure AD). The key changes include:

  • An additional note in the FAQ documentation highlighting the support for SSO integration, now referencing a new footnote which links to the SSO setup guide.
  • Updates to the guide sidebar to include the new 'Configure SSO with Microsoft Entra ID' page, ensuring easier discovery of the SSO configuration instructions.
  • The introduction of a new document that provides a comprehensive, step-by-step guide. This guide covers prerequisites, registration of an application in Entra ID, configuration of token claims, mapping of Entra groups to product roles, and testing the sign-in process.

These enhancements are aimed at helping customers properly integrate their Microsoft Entra ID with our product, ensuring a seamless and secure SSO experience without the need for a client secret.

Test Suggestions

  • Manually follow the new SSO guide instructions to configure integration with Microsoft Entra ID and verify that each step is clear and functional.
  • Check that the sidebar link navigates correctly to the new SSO guide page.
  • Verify that all cross-references and footnotes, such as [^12], properly link to the intended documentation sections.
  • Ensure consistency in formatting and style across the updated pages.

@nibalizer nibalizer added the documentation Improvements or additions to documentation label Jul 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview


| Entra security group | ValidMind role |
| --- | --- |
| `Data Scientists` | Developer |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

i wonder if it would be more clear to have this be an "id" instead of a name

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.

can do!

@github-actions

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.92 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (3 URL(s))

Show Lighthouse scores

Commit SHA: ebd152e

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/faq/faq-organizations.html 0.91 0.72 1.00 0.82
/faq/faq-organizations.html 0.91 0.75 1.00 0.82
/guide/configuration/configure-sso-with-entra.html 0.93 0.71 1.00 0.82
/guide/configuration/configure-sso-with-entra.html 0.93 0.74 1.00 0.82
/guide/configuration/managing-users.html 0.91 0.61 1.00 0.82
/guide/configuration/managing-users.html 0.91 0.65 1.00 0.82
/faq/faq-organizations.html 0.91 0.75 1.00 0.82
/guide/configuration/configure-sso-with-entra.html 0.93 0.73 1.00 0.82
/guide/configuration/managing-users.html 0.91 0.68 1.00 0.82

{{< var vm.product >}}'s login flow uses the Authorization Code Flow with PKCE as a public client — it never uses a client secret. Registering under **Web** instead of **SPA** will cause sign-in to fail with a CORS or token-response error.
:::

7. Open the app's **Authentication** blade and add the same URL again under **Front-channel logout URL**. This lets {{< var vm.product >}} sign users out of Entra ID cleanly when they log out.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We don't have a front channel signout

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Entra will just mark the token as expired and they will get signed out that way

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants