Skip to content

Commit aa14b28

Browse files
authored
Add managed domains to idp doc (#3443)
* add managed domains section
1 parent aa924a9 commit aa14b28

File tree

4 files changed

+29
-12
lines changed

4 files changed

+29
-12
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Some Identity Providers, such as the Google and OIDC Identity Providers, request access tokens from a configured remote URL. Remote servers must respond within a certain time frame or the login workflow will fail.
1+
Some Identity Providers, such as the Google and OIDC Identity Providers, request access tokens from a configured remote URL. Remote servers must respond within a certain time frame or the login workflow will fail. The limit is currently 10 seconds. It is not configurable.
22

3-
The limit is currently 10 seconds. It is not configurable.
3+
Managed domains can only be used with OIDC and SAMLv2 Identity Providers.

astro/src/content/docs/lifecycle/authenticate-users/identity-providers/_managed-domains-description.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ You may optionally scope this identity provider to one or more managed domains.
55
Adding one or more managed domains for this configuration will cause this provider not to be displayed as a button on your login page. Instead of a button the login form will first ask the user for their email address. If the user's email address matches one of the configured domains the user will then be redirected to this login provider to complete authentication. If the user's email address does not match one of the configured domains, the user will be prompted for a password and they will be authenticated using FusionAuth.
66

77
These configured domains will be used by the [Lookup API](/docs/apis/identity-providers/#lookup-an-identity-provider).
8+
9+
Learn more about [managed domains](/docs/lifecycle/authenticate-users/identity-providers/#managed-domains).

astro/src/content/docs/lifecycle/authenticate-users/identity-providers/index.mdx

+24-9
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ navOrder: 0
99
tags: authorization hub
1010
---
1111
import Aside from 'src/components/Aside.astro';
12+
import Breadcrumb from 'src/components/Breadcrumb.astro';
1213
import InlineField from 'src/components/InlineField.astro';
1314
import InlineUIElement from 'src/components/InlineUIElement.astro';
1415
import ScrollRef from 'src/components/ScrollRef.astro';
@@ -19,9 +20,9 @@ import IdentityProviderLimitations from 'src/content/docs/_shared/_identity-prov
1920

2021
Identity Providers allow you to enable third-party login in FusionAuth. This includes social options such as Facebook and Google, and enterprise options such as OIDC and SAML.
2122

22-
Find the FusionAuth Identity Providers in the UI by navigating to <strong>Settings -> Identity Providers</strong> or use the [Identity Providers](/docs/apis/identity-providers/) APIs.
23+
Find the FusionAuth Identity Providers in the UI by navigating to <Breadcrumb>Settings -> Identity Providers</Breadcrumb> or use the [Identity Providers](/docs/apis/identity-providers/) APIs.
2324

24-
<img src="/img/docs/get-started/core-concepts/identity-providers.png" alt="Identity Providers" width="1200" role="bottom-cropped" />
25+
![Identity Providers](/img/docs/get-started/core-concepts/identity-providers.png)
2526

2627
## Social Identity Providers
2728

@@ -59,15 +60,15 @@ Identity providers can be configured to set a limit on the number of links that
5960

6061
In the following, we have enabled "Limit links per user" on the Default tenant and set a "Maximum link count" of `2`. With this configuration, a user will only be able to establish at most two links for this IdP specifically.
6162

62-
<img src="/img/docs/lifecycle/authenticate-users/identity-providers/identity-provider-tenant-config.png" alt="Identity Providers" width="1200" role="bottom-cropped" />
63+
![Identity Providers](/img/docs/lifecycle/authenticate-users/identity-providers/identity-provider-tenant-config.png)
6364

6465
## Identity Providers and Applications
6566

6667
Identity providers can be enabled or disabled on a per application basis.
6768

6869
In the following screenshot you will see that we have enabled this login provider for the Pied Piper application and enabled "Create registration". Enabling "Create registration" means that a user does not need to be manually registered for the application prior to using this login provider.
6970

70-
<img src="/img/docs/lifecycle/authenticate-users/identity-providers/identity-provider-application-config.png" alt="Identity Providers" width="1200" role="bottom-cropped" />
71+
![Identity Providers](/img/docs/lifecycle/authenticate-users/identity-providers/identity-provider-application-config.png)
7172

7273
For example, when a new user attempts to log into Pied Piper using Google, if their user does not exist in FusionAuth it will be created dynamically, and if the Create registration toggle has been enabled, the user will also be registered for Pied Piper and assigned any default roles assigned by the application.
7374

@@ -85,7 +86,7 @@ You can have different identity provider configurations for different applicatio
8586

8687
You can override none, some or all of the available configuration values by expanding the <InlineUIElement>Overrides</InlineUIElement> element for the application's identity provider setting. You may also modify the <InlineField>identityProvider.applicationConfiguration</InlineField> values using the API.
8788

88-
<img src="/img/docs/lifecycle/authenticate-users/identity-providers/override-identity-provider-settings.png" alt="Overriding Identity Provider settings" width="1200" role="top-cropped" />
89+
![Overriding Identity Provider settings](/img/docs/lifecycle/authenticate-users/identity-providers/override-identity-provider-settings.png)
8990

9091
For certain Identity Providers, there are no override settings since you can create more than one. You can have multiple configurations for these Identity Provider types:
9192

@@ -113,6 +114,20 @@ An email address or domain may be provided in the `login_hint` request parameter
113114

114115
You can read more about the `login_hint` and `idp_hint` parameters in the [OAuth Endpoints documentation](/docs/lifecycle/authenticate-users/oauth/endpoints).
115116

117+
## Managed Domains
118+
119+
For SAML v2 or OIDC identity providers, you can optionally enable managed domains. This feature is not available for any other types of identity providers.
120+
121+
If users share a common email domain, such as `@example.com`, you can use managed domains to streamline their login process. Here's how it works:
122+
123+
- On the login page, users are prompted to enter their email address.
124+
- If the email domain matches a managed domain defined in the identity provider settings, the user is automatically redirected to the configured identity provider for authentication.
125+
- If the email domain does not match, the user proceeds to the standard email/password login flow.
126+
127+
Multiple email address domains can be managed by the same identity provider. Multiple identity providers can be configured with managed domains. Each email domain can be managed by at most one identity provider in a FusionAuth instance.
128+
129+
Configuring managed domains on an identity provider and then configuring the identity provider to be enabled for an application changes the login page experience for all users logging into this application. Every user viewing the application login page will be required to enter their email address first.
130+
116131
## Account Security
117132

118133
When you configure an Identity Provider, you are explicitly trusting this federated identity system to authenticate users. MFA requirements and configuration, roles and groups, email or phone verification, and account identifiers are controlled by the provider.
@@ -132,7 +147,7 @@ Such attacks can be mitigated by:
132147

133148
## Linking Strategies
134149

135-
<img src="/img/docs/lifecycle/authenticate-users/identity-providers/linking-strategy.png" alt="Linking Strategies" role="top-cropped bottom-cropped" width="1200" />
150+
![Linking Strategies](/img/docs/lifecycle/authenticate-users/identity-providers/linking-strategy.png)
136151

137152
The linking strategy is used when creating the link between the Identity Provider and the user account in FusionAuth.
138153

@@ -189,7 +204,7 @@ Richard is logging into Pied Piper. He has an account in FusionAuth with the ema
189204
* He logs in with `[email protected]`.
190205
* The FusionAuth account with the email `[email protected]` is linked to the Hooli `[email protected]` account.
191206

192-
<img src="/img/docs/lifecycle/authenticate-users/identity-providers/idp-linking-pending-link.png" alt="Screen prompting a user to connect their pending link account." width="1200" role="bottom-cropped" />
207+
![Screen prompting a user to connect their pending link account.](/img/docs/lifecycle/authenticate-users/identity-providers/idp-linking-pending-link.png)
193208

194209
### Anonymous Link
195210

@@ -205,7 +220,7 @@ Richard is logging into Pied Piper. He doesn't have an account in FusionAuth.
205220
* There is an account created in FusionAuth with no username or email address. It is not a full account.
206221
* Richard can interact with Pied Piper (a JWT is issued, etc), but cannot use FusionAuth workflows like 'forgot password'.
207222

208-
<img src="/img/docs/lifecycle/authenticate-users/identity-providers/idp-linking-anonymous-account.png" alt="Admin view of a user who has linked anonymously." width="1200" role="bottom-cropped" />
223+
![Admin view of a user who has linked anonymously.](/img/docs/lifecycle/authenticate-users/identity-providers/idp-linking-anonymous-account.png)
209224

210225
#### Anonymous Link, No Email Or Username Returned By The IdP
211226

@@ -256,7 +271,7 @@ Richard is logging into Pied Piper. He doesn't have an account in FusionAuth.
256271

257272
Here's an example of the error page:
258273

259-
<img src="/img/docs/lifecycle/authenticate-users/identity-providers/idp-linking-user-must-exist.png" alt="Error when a user must exist for successful linking." width="1200" role="bottom-cropped" />
274+
![Error when a user must exist for successful linking.](/img/docs/lifecycle/authenticate-users/identity-providers/idp-linking-user-must-exist.png)
260275

261276
#### Link On Email, User Account Is Created If Needed
262277

config/vale/styles/config/vocabularies/FusionAuth/accept.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,7 @@ idp_display_name
839839
idp_hint
840840
idp_request
841841
idp_token_or_code
842-
idp|IDP
842+
idp|IdP
843843
impactful
844844
incentivizes
845845
inclusivity

0 commit comments

Comments
 (0)