Skip to content

Commit 1f446fb

Browse files
docs: document verified domains for SSO routing (#715)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent ad41cde commit 1f446fb

2 files changed

Lines changed: 68 additions & 1 deletion

File tree

docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,8 @@
266266
"references/workspace/project-compilation-history",
267267
"references/workspace/groups",
268268
"references/workspace/scim-integration",
269-
"references/workspace/sso-providers"
269+
"references/workspace/sso-providers",
270+
"references/workspace/verified-domains"
270271
]
271272
},
272273
"references/workspace/feature-maturity-levels"
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "Verified domains"
3+
description: "Prove ownership of your organization's domains to control SSO routing in Lightdash."
4+
---
5+
6+
<CardGroup cols={2}>
7+
<Card title="Cloud Pro" icon="rocket" horizontal />
8+
<Card title="Cloud Enterprise" icon="rocket" horizontal />
9+
</CardGroup>
10+
11+
<Info>
12+
Verified domains are part of per-organization SSO settings. Contact the Lightdash team if you don't see the **Verified domains** panel in your settings.
13+
</Info>
14+
15+
## What are verified domains?
16+
17+
A verified domain is a domain your organization has proven it owns by receiving a one-time passcode at an email address on that domain.
18+
19+
Verified domains are the source of truth for **SSO routing**: when a user signs in with an email on a verified domain, Lightdash sends them to the SSO provider you've configured for your organization. Only one organization can hold a verified domain at a time — verification is first-come, first-served.
20+
21+
Use verified domains when you want to:
22+
23+
- Route users on your domain to your organization's SSO provider.
24+
- Restrict an individual SSO method (Google, Okta, Azure AD, OneLogin, Generic OIDC) to a subset of your organization's domains.
25+
26+
<Note>
27+
Verified domains control **SSO routing only**. They are separate from [allowed email domains](/get-started/setup-lightdash/invite-new-users), which control which users can auto-join your organization.
28+
</Note>
29+
30+
## Verify a domain
31+
32+
You must be an organization admin to verify a domain.
33+
34+
1. In your Lightdash instance, click your initials at the top right and select **Organization settings**.
35+
2. Open the **Verified domains** panel.
36+
3. Click **Add domain**, then select **Email**.
37+
4. Enter an email address on the domain you want to verify (for example, `admin@yourcompany.com`). Public email providers like `gmail.com` or `outlook.com` aren't accepted.
38+
5. Click **Send code**. Lightdash emails a 6-digit one-time passcode to that address.
39+
6. Enter the code before the on-screen timer expires. If the code expires or you exceed the attempt limit, request a new one.
40+
41+
Once verified, the domain appears in the list with a **Verified** badge.
42+
43+
## Remove a verified domain
44+
45+
In the **Verified domains** panel, click **Remove** next to the domain. Removing a verified domain stops Lightdash from routing that domain's users to your SSO providers and frees the domain so another organization can claim it.
46+
47+
<Warning>
48+
If an SSO method is configured to route only a subset of verified domains (see below), removing the underlying verified domain also removes it from that subset.
49+
</Warning>
50+
51+
## Routing SSO methods to verified domains
52+
53+
Each SSO method in your organization (Google, Okta, Azure AD, OneLogin, Generic OIDC) routes users by email domain.
54+
55+
In the SSO method's settings panel:
56+
57+
- Leave **Override organization domains** off to route **all** of your organization's verified domains to this method. This is the default and works for most setups.
58+
- Turn **Override organization domains** on to restrict this method to a **subset** of your verified domains. You can only select domains that are already verified.
59+
60+
If you don't have any verified domains yet, the override field links you back to the **Verified domains** panel.
61+
62+
## Related resources
63+
64+
- [SSO providers](/references/workspace/sso-providers)
65+
- [Self-hosted SSO configuration](/self-host/customize-deployment/use-sso-login-for-self-hosted-lightdash)
66+
- [Allowing users to auto-join your organization](/get-started/setup-lightdash/invite-new-users)

0 commit comments

Comments
 (0)