240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
57 lines
5.3 KiB
Plaintext
57 lines
5.3 KiB
Plaintext
---
|
|
title: "Configure SAML synchronization with AD/LDAP"
|
|
unlisted: true
|
|
---
|
|
{/* Snippet include: imported by every SAML identity provider page. */}
|
|
|
|
In addition to configuring SAML sign-in, you can optionally configure synchronizing SAML accounts with AD/LDAP. When configured:
|
|
|
|
- Mattermost queries AD/LDAP for relevant account information and updates SAML accounts based on changes to attributes (first name, last name, and nickname)
|
|
- Accounts disabled in AD/LDAP are deactivated in Mattermost, and their active sessions are revoked once Mattermost synchronizes attributes.
|
|
|
|
To configure SAML synchronization with AD/LDAP:
|
|
|
|
1. Go to **System Console \> Authentication \> SAML 2.0**, then set **Enable Synchronizing SAML Accounts With AD/LDAP** to **true**.
|
|
|
|
2. Go to **System Console \> Authentication \> AD/LDAP** to open the AD/LDAP wizard, navigate to the **Connection Settings** section, then set **Enable Synchronization with AD/LDAP** to **true**.
|
|
|
|
3. To ignore guest users when sychronizing, go to **System Console \> Authentication \> SAML 2.0**, then set **Ignore Guest Users when Synchronizing with AD/LDAP** to **true**.
|
|
|
|
4. Set the rest of the AD/LDAP settings based on [configuration settings documentation](/administration-guide/configure/authentication-configuration-settings#adldap) to connect Mattermost with your AD/LDAP server.
|
|
|
|
If you don't want to enable AD/LDAP sign-in, go to **System Console \> Authentication \> AD/LDAP** wizard, navigate to the **Connection Settings** section, then set **Enable sign-in with AD/LDAP** to **false**.
|
|
|
|
5. To specify how often Mattermost synchronizes SAML user accounts with AD/LDAP, go to **System Console \> Authentication \> AD/LDAP** wizard, navigate to the **Sync Performance** section, then set a **Synchronization Interval** in minutes. The default setting is 60 minutes. If you want to synchronize immediately after disabling an account, go to the **Sync History** section and select **AD/LDAP Synchronize Now**.
|
|
|
|
6. To confirm that Mattermost can successfully connect to your AD/LDAP server, go to **System Console \> Authentication \> AD/LDAP** wizard, navigate to the **Connection Settings** section, then select **Test Connection**.
|
|
|
|
Once the synchronization with AD/LDAP is enabled, user attributes are synchronized with AD/LDAP based on their email address. If a user with a given email address doesn't have an AD/LDAP account, they will be deactivated in Mattermost on the next AD/LDAP sync.
|
|
|
|
To re-activate the account:
|
|
|
|
1. Add the user to your AD/LDAP server.
|
|
2. Purge all caches in Mattermost by going to **System Console \> Environment \> Web Server**, then select **Purge All Caches**.
|
|
3. Run AD/LDAP synchronization by going to **System Console \> Authentication \> AD/LDAP** wizard, navigating to the **Sync History** section, then select **AD/LDAP Synchronize Now**.
|
|
4. Purge all caches again in Mattermost by going to **System Console \> Environment \> Web Server**, then select **Purge All Caches** again. This re-activates the account in Mattermost.
|
|
|
|
<Note>
|
|
|
|
\- If a user is deactivated from AD/LDAP, they will be deactivated in Mattermost on the next sync. They will be shown as "Deactivated" in the System Console users list, all of their sessions will expire and they won't be able to log back in to Mattermost. - If a user is deactivated from SAML, their session won't expire until they're deactivated from AD/LDAP. However, they won't be able to log back in to Mattermost. - SAML synchronization with AD/LDAP is designed to pull user attributes such as first name and last name from your AD/LDAP, not to control authentication. In particular, the user filter cannot be used to control who can log in to Mattermost, this should be controlled by your SAML service provider's group permissions.
|
|
|
|
</Note>
|
|
|
|
See [technical description of SAML synchronization with AD/LDAP](/administration-guide/onboard/sso-saml-technical) for more details.
|
|
|
|
## Override SAML data with AD/LDAP data
|
|
|
|
Alternatively, you can choose to override SAML bind data with AD/LDAP information. For more information on binding a user with the SAML ID Attribute, please refer to this [documentation](/administration-guide/onboard/sso-saml-okta#how-to-bind-authentication-to-id-attribute-instead-of-email).
|
|
|
|
This process overrides SAML email address with AD/LDAP email address data or SAML Id Attribute with AD/LDAP Id Attribute if configured. We recommend using this configuration with the SAML ID Attribute to help ensure new users are not created when the email address changes for a user.
|
|
|
|
To ensure existing user accounts do not get disabled in this process, ensure the SAML IDs match the LDAP IDs by exporting data from both systems and comparing the ID data. Mapping ID Attributes for both AD/LDAP and SAML within Mattermost to fields that hold the same data will ensure the IDs match as well.
|
|
|
|
1. Set the SAML `Id Attribute` by going to **System Console \> Authentication \> SAML 2.0 \> Id Attribute**.
|
|
2. Set **System Console \> Authentication \> SAML 2.0 \> Override SAML bind data with AD/LDAP information** to **true**.
|
|
3. Set **System Console \> Authentication \> SAML 2.0 \> Enable Synchronizing SAML Accounts With AD/LDAP** to **true**.
|
|
4. Run AD/LDAP sync by going to **System Console \> Authentication \> AD/LDAP** wizard, navigating to the **Sync History** section, then select **AD/LDAP Synchronize Now**.
|