Skip to content

Commit dd5b7eb

Browse files
create the SSO Domain Restrictions page (#102)
1 parent 1e011b2 commit dd5b7eb

File tree

6 files changed

+86
-7
lines changed

6 files changed

+86
-7
lines changed
129 KB
Loading

docs/images/allow-all-users.png

244 KB
Loading

docs/images/allow-specific-users.png

258 KB
Loading

docs/user-guide/management/.pages

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ nav:
55
- Templates: templates.md
66
- Audit trail: audit-trail.md
77
- Cipher Keys: cipher-keys.md
8-
- Nodes in OpenObserve: nodes.md
8+
- Nodes in OpenObserve: nodes.md
9+
- SSO Domain Restrictions: sso-domain-restrictions.md

docs/user-guide/management/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ The Management section includes tools for maintaining and securing OpenObserve o
22

33
Learn more:
44

5-
- [Query Management](query-management.md)
6-
- [Alert Destinations](alert-destinations.md)
7-
- [Templates](templates.md)
8-
- [Audit trail](audit-trail.md)
9-
- [Cipher Keys](cipher-keys.md)
10-
- [Nodes in OpenObserve](nodes.md)
5+
- [Query Management](../management/query-management/)
6+
- [Alert Destinations](../management/alert-destinations/)
7+
- [Templates](../management/templates/)
8+
- [Audit trail](../management/audit-trail/)
9+
- [Cipher Keys](../management/cipher-keys/)
10+
- [Nodes in OpenObserve](../management/nodes/)
11+
- [SSO Domain Restrictions](../management/sso-domain-restrictions/)
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: SSO Domain Restrictions User Guide - OpenObserve Enterprise
3+
description: Learn how to configure SSO domain restrictions in OpenObserve Enterprise to control user access by email domains and enhance security.
4+
---
5+
> This feature is only available in the OpenObserve Enterprise Edition.
6+
7+
This user guide provides step-by-step instructions for configuring and managing **SSO Domain Restrictions** in OpenObserve. <br>
8+
This feature allows you to control which users can log in to OpenObserve using Single Sign-On (SSO) providers. You can allow access to specific domains or even individual users from those domains.
9+
10+
!!! note "Where to Find"
11+
The **SSO Domain Restrictions** page is available in the `_meta` org under **Management**.
12+
13+
!!! note "Who Can Access"
14+
`Root` user and any other user who has access to the `_meta` org can access the **SSO Domain Restrictions** page.
15+
16+
## Add Domain Restrictions
17+
18+
??? "Step 1: Add a New Domain"
19+
1. In the **Domain and allowed users** section, enter the domain name in the text field.
20+
> Enter only the domain name, for example, `example.com` and do not include the `@` symbol.
21+
2. Click the **Add Domain** button.
22+
![Add a New Domain](../../images/add-new-domain-sso-restrict.png)
23+
24+
??? "Step 2: Configure Domain Access"
25+
26+
For each domain, you have two control options:
27+
28+
**Option 1: Allow All Users from Domain**<br>
29+
It permits any user with an email address from the selected domain to log in using SSO. <br>
30+
> **Use case:** Allow all employees from your company domain `@example.com`.
31+
<br>
32+
![Allow all users](../../images/allow-all-users.png)
33+
34+
**Option 2: Allow Specific Users Only**<br>
35+
It allows you to add individual email addresses that should be permitted to log in using SSO.<br>
36+
> **Use case**: Allow only certain users from a partner organization. For example, `e1@example1.com` and `e2@example1.com`.
37+
38+
When **Allow only specific users** is selected:
39+
<br>
40+
![Allow only specific users](../../images/allow-specific-users.png)
41+
42+
1. Enter the complete email address in the input field.
43+
2. Click **Add Email**.
44+
3. The email address will be added to the allowed list.
45+
4. Repeat for additional users.
46+
5. Use the **X** button next to any email to remove it.
47+
48+
??? "Step 3: Save Configuration"
49+
1. Review your domain restrictions.
50+
2. Click **Save Changes** to apply the configuration.
51+
3. Click **Cancel** to discard changes.
52+
53+
54+
## Domain Limits
55+
There is no limit on the number of domains you can configure. Add as many domains and specific users as needed for your organization.
56+
57+
## Error Messages
58+
When **SSO Domain Restrictions** are configured, any user attempting to log in from domains or email addresses that are **NOT** in the allowed list will see an `unauthorized` error during SSO login.
59+
60+
## Supported SSO Login Options
61+
OpenObserve allows users to log in through the following Single Sign-On options, and domain restrictions apply to all of them:
62+
63+
- GitHub
64+
- GitLab
65+
- Google
66+
- Microsoft
67+
68+
Domain restrictions will be enforced when users attempt to log in using any of these SSO options.
69+
70+
## Troubleshooting
71+
**Problem**: SSO Domain Restrictions menu not visible. <br>
72+
**Solution**: Verify you are in the `_meta` organization. <br>
73+
74+
**Problem**: Changes not taking effect. <br>
75+
**Solution**: Ensure you clicked **Save Changes** and refresh the login page. <br>
76+
77+

0 commit comments

Comments
 (0)