Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Microsoft Connector: domainHint configuration parameter #118

Merged
merged 2 commits into from
Apr 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions content/docs/connectors/microsoft.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,23 @@ connectors:
tenant: organizations
```

`domainHint` configuration parameter allows for a more streamlined login
experience when the email domain is common to all users of the connector.
By default, users with multiple Microsoft sessions will be prompted to choose
which account they want to use for login. When `domainHint` is configured,
Microsoft will select the session with matching email without the interactive
prompt.

For example: user John Doe has 2 active Microsoft sessions:

- John.Doe@live.com (consumer)
- John.Doe@example.com (organization)

If Example Organization configures the `domainHint` parameter with its
organization's email suffix, John will not be prompted to select an account
from the active sessions. Instead, the matching organization session is
selected automatically.

`scopes` configuration parameter controls what the initial scope(s) of the identity
token that dex requests from Microsoft. To change this initial set, configure
the `scopes` parameter to be a list of one or more valid scopes (as defined in
Expand All @@ -116,6 +133,8 @@ connectors:
clientID: $MICROSOFT_APPLICATION_ID
clientSecret: $MICROSOFT_CLIENT_SECRET
redirectURI: http://127.0.0.1:5556/dex/callback
tenant: example.onmicrosoft.com
domainHint: example.com
scopes:
- openid
- email
Expand Down