Skip to content

Commit 7895846

Browse files
Single sign-on docs for Cloud (#641)
--------- Co-authored-by: Tomas Mizera <tomas.mizera@lutraconsulting.co.uk>
1 parent 7554da4 commit 7895846

11 files changed

+100
-12
lines changed

scripts/wordlist.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ SLA
135135
SMTP
136136
SQLAlchemy
137137
SSH
138+
SSO
138139
SVG
139140
SVGs
140141
SaaS
@@ -291,14 +292,15 @@ workspaces
291292
www
292293
zlib
293294
zoomstack
295+
Entra
296+
Auth
297+
SAML
298+
OIDC
294299
SSO
295300
Ory
296301
Polis
297302
SAML
298-
sso
299303
yaml
300-
Entra
301304
pre
302305
env
303-
OIDC
304-
IDP
306+
IDP
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<template>
2+
<span class="nospellcheck">Mergin Maps dashboard</span>
3+
</template>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<template>
2+
<span class="nospellcheck">dashboard</span>
3+
</template>
Loading
Binary file not shown.
Loading

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

Lines changed: 88 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
1-
# How to Sign Up to Mergin Maps
2-
[[toc]]
1+
---
2+
outline: deep
3+
---
34

4-
To make full use of the <MainPlatformNameLink /> service, you need to sign up. You can sign up either through <MainDomainNameLink /> or from your mobile device using the <MobileAppName />.
5+
# How to Sign Up to Mergin Maps
56

6-
Public projects can be accessed and downloaded even without a <MainPlatformNameLink /> account, but projects can be managed, shared and synchronised only when you are logged in.
7+
To make full use of <MainPlatformName />, you need to sign up. You can sign up using:
8+
- [Email and password](#email-and-password-sign-up)
9+
- [Single sign-on (SSO)](#single-sign-on-sso)
710

811
::: tip Manage your account
912
Do you want to delete your account or change your details? Go to [**User Account**](../../manage/account/) for detailed steps.
1013
:::
1114

12-
## From web
15+
::: tip Account-less access
16+
Public projects can be accessed and downloaded even without a <MainPlatformName /> account. However, to manage, share or upload changes to projects, you need to be signed in.
17+
:::
18+
19+
## Email and password sign up
20+
21+
Password sign up to <MainPlatformName/> is available via <DashboardNameShort/> or <MobileAppNameShort/>.
1322

14-
1. Navigate to <AppDomainNameLink id=register />
23+
### From dashboard
24+
25+
1. Navigate to <AppDomainNameLink/>
1526

1627
2. Fill in the registration form and click on **Sign Up**.
1728
![Mergin Maps sign up form](./mergin-web-sign-up.jpg "Mergin Maps sign up form")
@@ -39,7 +50,9 @@ You can get up-to-speed quickly by following our [Quick Start tutorials](../../t
3950
See our <MainDomainNameLink id="pricing" desc="pricing page"/> for more details.
4051
:::
4152

42-
### Invitation to a workspace
53+
<!--- is this section still relevant?
54+
55+
#### Invitation to a workspace
4356
If someone invited you to join their workspace, you will get an email with the invitation link. You need to have a <MainPlatformName /> account in order to contribute to this workspace.
4457
4558
1. Use the link to get the registration form. Your email address will be filled in automatically, so you just need to enter a username and password.
@@ -53,8 +66,9 @@ If someone invited you to join their workspace, you will get an email with the i
5366
5467
You can get up-to-speed quickly by following our [Quick Start tutorials](../../tutorials/capturing-first-data/).
5568
69+
-->
5670

57-
## From Mergin Maps mobile app
71+
### From mobile app {#from-mergin-maps-mobile-app}
5872
You can also sign up from <MobileAppName />.
5973

6074
1. Download the <MobileAppNameShort /> to your Android device, iPhone or iPad. You can find it in the app store of your platform:
@@ -90,3 +104,69 @@ You can get up-to-speed quickly by following our [Quick Start tutorials](../../t
90104
See our <MainDomainNameLink id="pricing" desc="pricing page"/> for more details.
91105
:::
92106

107+
## Single sign-on (SSO)
108+
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.
109+
110+
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 />.
111+
112+
<MainPlatformName /> account will be created automatically after the first sign in via SSO.
113+
114+
SSO is available on the <DashboardNameShort />, the <MobileAppNameShort /> and the <QGISPluginNameShort />.
115+
116+
### Connection setup
117+
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"/>.
118+
119+
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.
120+
121+
::: tip SSO for self-hosted servers <ServerType type="EE" />
122+
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.
123+
124+
SSO is not available for <CommunityPlatformName />.
125+
:::
126+
127+
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"/>.
128+
129+
![Mergin Maps workspace settings with enabled SSO](./dashboard-workspace-settings-sso.jpg "Mergin Maps workspace settings with enabled SSO")
130+
131+
### From dashboard
132+
To sign in or sign up to <MainPlatformName /> using SSO on the <DashboardShortLink />:
133+
1. Navigate to <AppDomainNameLink />
134+
2. Click on the **Continue with SSO** button
135+
3. Enter your email address associated with your organisation and click **Sign in**
136+
4. You will be redirected to an identity provider. Enter your credentials.
137+
5. After being redirected back to the <DashboardShortLink /> , you will be signed in.
138+
139+
![Mergin Maps dashboard single sign-on](./dashboard-sso-sign-up.jpg "Mergin Maps dashboard single sign-on")
140+
141+
### From mobile app
142+
143+
1. Open the <MobileAppNameShort />. Tap the account icon in the upper right corner to go to the login page.
144+
![Mergin Maps mobile app account icon](./mobile-app-account-icon.jpg "Mergin Maps mobile app account icon")
145+
146+
2. Tap the **Continue with SSO** option
147+
![Mergin Maps mobile app single sign-on](./mobile-sso-sign-in.jpg "Mergin Maps mobile app single sign-on")
148+
149+
4. Enter your email address associated with your organisation and click **Sign in**.
150+
151+
You will be redirected to an identity provider. Enter your credentials.
152+
153+
5. After successful authentication, you will be signed in to <MainPlatformName /> in the <MobileAppNameShort />.
154+
155+
156+
### From QGIS plugin
157+
158+
::: warning QGIS version 3.40.0 or higher is required
159+
<QGISPluginName /> installed on QGIS version lower than 3.40.0 will not have the option to sign in via SSO.
160+
:::
161+
162+
To use SSO in the <QGISPluginNameShort />:
163+
1. Open QGIS
164+
2. On the toolbar, click on the **Configure <MainPlatformName /> plugin** button
165+
![Configure Mergin Maps Plugin](../install-mergin-maps-plugin-for-qgis/qgis-configure-mergin-plugin.jpg "Configure Mergin Maps Plugin")
166+
3. Use the **Continue with SSO** option to open SSO sign in
167+
![Mergin Maps QGIS plugin single sign-on](./plugin-sso-sign-in.jpg "Mergin Maps QGIS plugin single sign-on")
168+
4. Enter your email address associated with your organisation and click **OK**.
169+
170+
You will be redirected to an identity provider. Enter your credentials.
171+
5. After successful authentication, you will be signed in to <MainPlatformName /> in <QGISPluginNameShort />.
172+
Loading
Binary file not shown.
Loading

0 commit comments

Comments
 (0)