Skip to content
Snippets Groups Projects
Commit 08b9677f authored by Sameer Al-Sakran's avatar Sameer Al-Sakran Committed by GitHub
Browse files

Merge pull request #5517 from metabase/ldap-docs

LDAP docs
parents 066bb8a8 165a7a55
No related branches found
No related tags found
No related merge requests found
## Single Sign-On with Google
## Authenticating with Google Sign-In or LDAP
Enabling single sign-on lets your team log in with a click instead of using email and password and can optionally let them sign up for Metabase accounts without an admin having to create them first.
Enabling Google Sign-In or LDAP lets your team log in with a click instead of using email and password, and can optionally let them sign up for Metabase accounts without an admin having to create them first. You can find these options in the Settings section of the Admin Panel, under Authentication.
Currently Metabase works with Google accounts for single sign-on. As time goes on we may add other auth providers. If you have a service you’d like to see work with Metabase please let us know by [filing an issue](http://github.com/metabase/metabase/issues/new).
![Authentication](./images/authentication.png)
### Enabling Sign in
As time goes on we may add other auth providers. If you have a service you’d like to see work with Metabase please let us know by [filing an issue](http://github.com/metabase/metabase/issues/new).
### Enabling Google Sign-In
To let your team start signing in with Google you’ll first need to create an application through Google’s [developer console](https://console.developers.google.com/projectselector/apis/library).
......@@ -16,14 +18,30 @@ Once you have your client_id, copy and paste it into the box on the Single Sign-
Now existing Metabase users signed into a Google account that matches their Metabase account email can sign in with just a click.
### Enabling Sign up
### Enabling account creation with Google Sign-In
If you’ve added your Google client ID to your Metabase settings you can also let users sign up on their own without creating accounts for them.
To enable this, go to the Google Sign-In configuration page, and specify the email domain you want to allow. For example, if you work at WidgetCo you could enter `widgetco.com` in the field to let anyone with a company email sign up on their own.
Note: Metabase accounts created with Google Sign-In do not have passwords and must use Google to sign in to Metabase.
### Enabling LDAP authentication
If your organization uses LDAP, and you want to allow your users to log in via their LDAP credentials, you can do so as follows.
Click the `Configure` button in the LDAP section of the Authentication page, and you'll see this form:
![Authentication](./images/ldap-form.png)
If you’ve added your Google client id to your Metabase settings you can also let users sign up on their own without creating accounts for them.
Click the toggle at the top of the form to enable LDAP, then fill in the form with the information about your LDAP server.
To enable this, check the box on the Single Sign-On Admin Settings page and specify the email domain you want to allow. For example if you work at WidgetCo you could enter widgetco.com in the field to let anyone with a company email sign up on their own.
Metabase will pull out three main attributes from your LDAP directory - email (defaulting to the `mail` attribute), first name (defaulting to the `givenName` attribute) and last name (defaulting to the `sn` attribute). If your LDAP setup uses other attributes for these, you can edit this under the "Attributes" portion of the form.
Note: Metabase accounts created with Single Sign-On do not have passwords and must use Google to sign in to Metabase.
![Attributes](./images/ldap-attributes.png)
If you have user groups in Metabase you are using to control access, it is often tedious to have to manually assign a user to a group after they're logged in via SSO. You can take advantage of the groups your LDAP directory uses by enabling Group Mappings, and specifying which LDAP group corresponds to which user group on your Metabase server.
---
......
docs/administration-guide/images/authentication.png

63 KiB

docs/administration-guide/images/ldap-attributes.png

147 KiB

docs/administration-guide/images/ldap-form.png

76.4 KiB

......@@ -13,7 +13,7 @@ Are you in charge of managing Metabase for your organization? Then you're in the
* [Creating segments and metrics](07-segments-and-metrics.md)
* [Configuring settings](08-configuration-settings.md)
* [Setting up Slack integration](09-setting-up-slack.md)
* [Enabling single sign-on with Google](10-single-sign-on.md)
* [Authenticating with Google Sign-In or LDAP](10-single-sign-on.md)
* [Creating a Getting Started Guide for your team](11-getting-started-guide.md)
* [Sharing dashboards and questions with public links](12-public-links.md)
* [Embedding Metabase in other Applications](13-embedding.md)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment