Skip to content

docs: document that only a server administrator can set the organization SSO domain #1131

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.

Sign up for GitHub

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

Open
Anty0 wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −2
Open

docs: document that only a server administrator can set the organization SSO domain #1131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion platform/sso/sso_getting_started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ After you have registered and configured the OIDC application, you need to provi
data={[
{
item: 'Domain name',
description: 'Used to identify the organization on login page',
description: 'E-mail domain used to identify the organization on the login page. Only a server administrator can set or change it',
},
{
item: 'Client ID',
Expand All @@ -63,6 +63,15 @@ After you have registered and configured the OIDC application, you need to provi
]}
/>

:::caution Domain name is set by a server administrator
The `Domain name` field is read-only for organization owners, so you cannot fill it in or change it yourself. Ask a
server administrator to set it for your organization. On Tolgee Cloud, contact us via the chat on our website or our
community [Slack channel](https://Tolg.ee/slack). On a self-hosted instance, ask the user who administers your Tolgee
server.

The domain name is required for an enabled SSO configuration, so you cannot turn SSO on until an administrator has set
it. Members are matched to your organization by their e-mail domain when they log in.
:::

After you have provided this information, click the **Save** button. You can now log in to your Tolgee account using SSO.
For this purpose, you can use the **Login with SSO** button on the login page and provide your organization's domain name.
Expand Down
12 changes: 11 additions & 1 deletion platform/sso/sso_server_setup_organizations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,14 @@ tolgee:
enabled: true
```

Restart your Tolgee server to apply the changes, then follow the [SSO Getting Started](/platform/sso/sso_getting_started) guide to set up the SSO for specific organizations.
Restart your Tolgee server to apply the changes, then follow the [SSO Getting Started](/platform/sso/sso_getting_started) guide to set up the SSO for specific organizations.

## Set the domain name for an organization

Organization owners can fill in all SSO fields except the domain name, which only a server administrator can set. This
prevents an organization from claiming an e-mail domain it does not own, because every user signing in with that domain
is routed to the organization.

To set it, sign in with an account that has server administrator rights, go to the `Administration` section, find the
organization in the `Organizations` list, click its `Settings` button, and fill in the `Domain name` field in the
`Single Sign-On (SSO)` section. For everyone else the field stays read-only.
Loading