Skip to content

Commit f6339bc

Browse files
authored
add sso page (#649)
1 parent 95e5b49 commit f6339bc

File tree

7 files changed

+45
-23
lines changed

7 files changed

+45
-23
lines changed

src/.vitepress/sidebar/en.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ export default {
2727
collapsed: true,
2828
items: [
2929
{ text: 'User Account', link: '/manage/account/' },
30+
{ text: 'Single Sign-On (SSO)', link: '/manage/sso/' },
3031
{ text: 'Workspaces', link: '/manage/workspaces/' },
3132
{ text: 'Subscriptions and Invoicing', link: '/manage/subscriptions/' },
3233
{ text: 'Member Roles and Permissions', link: '/manage/permissions/' },

src/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ The ecosystem consist of various components:
3939

4040
## Manage Account & Project
4141
- [User Account](./manage/account/)
42+
- [Single Sign-On (SSO)](./manage/sso/)
4243
- [Workspaces](./manage/workspaces/)
4344
- [Subscriptions and Invoicing](./manage/subscriptions/)
4445
- [Member Roles and Permissions](./manage/permissions/)

src/manage/dashboard/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,16 @@ For details about different subscription plans visit our <MainDomainNameLink id=
100100
:::
101101

102102
## Settings
103-
In the **Settings** tab, you will find information about the current workspace.
103+
In the **Settings** tab, you will find information about the current workspace.
104+
105+
Here, [admins and owners](../permissions/#workspace-member-roles-and-project-permissions) of a workspace can set up or manage [Single sign-on (SSO)](../sso/).
106+
107+
[Owners](../permissions/#workspace-member-roles-and-project-permissions) of a workspace can also:
104108
- use **Edit Workspace** to add or change the description of the workspace
105109
- use **Close Workspace** to [delete the workspace](../workspaces/#how-to-delete-a-workspace)
106110

107111
![Mergin dashboard web workspace settings](./mergin-maps-dashboard-settings.jpg "Mergin Maps dashboard workspace settings")
108112

109-
110113
## User profile
111114
**Your profile** can be accessed by clicking on the user name in the upper right corner.
112115

src/manage/permissions/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ This is the overview of workspace member roles that are related to the whole wor
4949
|delete and transfer projects| :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :white_check_mark: | :white_check_mark: |
5050
|manage access to projects| :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :white_check_mark: | :white_check_mark: |
5151
|manage workspace members| :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :white_check_mark: | :white_check_mark: |
52+
|set up and manage [SSO](../sso/)| :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :white_check_mark: | :white_check_mark: |
5253
|delete the workspace and change its description| :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :white_check_mark: |
5354
|access to invoicing and subscription settings| :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :no_entry_sign: | :white_check_mark: |
5455

src/manage/sso/index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Single Sign-On (SSO)
2+
[[toc]]
3+
4+
Single sign-on (SSO) is an authentication method that allows you to sign in to <MainPlatformName /> using the same credentials as you use in your organisation. SSO is available on the <DashboardNameShort />, the <MobileAppNameShort /> and the <QGISPluginNameShort />.
5+
6+
This means you don't have to create a new <MainPlatformName /> account with a specific password: you can simply use your work email. The identity provider (e.g. Microsoft Entra ID or Auth0) used by your organisation will check your credential and redirect you back to <MainPlatformName />.
7+
8+
<MainPlatformName /> account will be created automatically after the first sign in via SSO.
9+
10+
When a user signs in to <MainPlatformName /> using SSO, they will stay signed in for a time period before they are asked to enter their credentials again. By default, this period is set to 14 days. If you use <EnterprisePlatformNameLink />, you can set it to a different value.
11+
12+
::: warning Removing workspace users
13+
If you remove a user from your Identity provider (you remove their account in your organisation), they will still be able to log into the <MainPlatformName /> workspace for 14 days.
14+
15+
To cancel their access to the workspace immediately, you have to remove them manually through the [Members tab](../dashboard/#members) on the <DashboardShortLink />.
16+
:::
17+
18+
### Connection setup
19+
If you are the admin or owner of a workspace and you want to set up SSO, please contact our <MainDomainNameLink id="contact-sales" desc="sales team"/>.
20+
21+
You will receive a link with a step-by-step guide for your identity provider. Currently, we support **SAML** and **OIDC** SSO protocols. Directory sync is not supported.
22+
23+
::: tip SSO for self-hosted servers <ServerType type="EE" />
24+
If you want to use SSO on your <EnterprisePlatformNameLink /> server, you can do so from the admin panel. See [Single Sign-On Deployment](../../server/sso-deployment/) for more details.
25+
26+
SSO is not available for <CommunityPlatformName />.
27+
:::
28+
29+
Once SSO is configured for your workspace, you will see the relevant information in the <DashboardLink id="settings" desc="workspace settings page"/>, under the *advanced* section. If you need to make any changes to your SSO connection, please <MerginMapsEmail id="support" desc="contact our support team"/>.
30+
31+
![Mergin Maps workspace settings with enabled SSO](./dashboard-workspace-settings-sso.jpg "Mergin Maps workspace settings with enabled SSO")
32+

src/setup/sign-up-to-mergin-maps/index.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ outline: deep
66

77
To make full use of <MainPlatformName />, you need to sign up. You can sign up using:
88
- [Email and password](#email-and-password-sign-up)
9-
- [Single sign-on (SSO)](#single-sign-on-sso)
9+
- [Single sign-on (SSO)](#single-sign-on)
1010

1111
::: tip Manage your account
1212
Do you want to delete your account or change your details? Go to [**User Account**](../../manage/account/) for detailed steps.
@@ -107,30 +107,14 @@ You can get up-to-speed quickly by following our [Quick Start tutorials](../../t
107107
See our <MainDomainNameLink id="pricing" desc="pricing page"/> for more details.
108108
:::
109109

110-
## Single sign-on (SSO)
111-
Single sign-on (SSO) is an authentication method that allows you to sign in to <MainPlatformName /> using the same credentials as you use in your organisation.
110+
## Single sign-on
112111

113-
This means you don't have to create a new <MainPlatformName /> account with a specific password: you can simply use your work email. The identity provider (e.g. Microsoft Entra ID or Auth0) used by your organisation will check your credential and redirect you back to <MainPlatformName />.
112+
If your organisation set up [SSO](../../manage/sso/) for <MainPlatformName />, you can sign in using the same credentials as you use in your organisation.
114113

115-
<MainPlatformName /> account will be created automatically after the first sign in via SSO.
116-
117-
SSO is available on the <DashboardNameShort />, the <MobileAppNameShort /> and the <QGISPluginNameShort />.
118-
119-
### Connection setup
120-
If you are the admin or owner of a workspace and you want to set up SSO, please contact our <MainDomainNameLink id="contact-sales" desc="sales team"/>.
121-
122-
You will receive a link with step-by-step guide for your identity provider. Currently, we support **SAML** and **OIDC** SSO protocols. Directory sync is not supported.
123-
124-
::: tip SSO for self-hosted servers <ServerType type="EE" />
125-
If you want to use SSO on your <EnterprisePlatformNameLink /> server, you can do so from the admin panel. See [Single Sign-On Deployment](../../server/sso-deployment/) for more details.
126-
127-
SSO is not available for <CommunityPlatformName />.
114+
::: tip
115+
You can find out more about this topic in [Single Sign-On (SSO)](../../manage/sso/).
128116
:::
129117

130-
Once SSO is configured for your workspace, you will see the relevant information in the <DashboardLink id="settings" desc="workspace settings page"/>, under the *advanced* section. If you need to make any changes to your SSO connection, please <MerginMapsEmail id="support" desc="contact our support team"/>.
131-
132-
![Mergin Maps workspace settings with enabled SSO](./dashboard-workspace-settings-sso.jpg "Mergin Maps workspace settings with enabled SSO")
133-
134118
### From dashboard
135119
To sign in or sign up to <MainPlatformName /> using SSO on the <DashboardShortLink />:
136120
1. Navigate to <AppDomainNameLink />

0 commit comments

Comments
 (0)