Mattermost Plugin Identity Groups Sync

Identity Groups Sync Mattermost Plugin

This plugin synchronizes user groups from Keycloak to Mattermost.

License

This repository is licensed under the [Mattermost Source Available License](LICENSE) and requires a valid Enterprise Edition License when used for production. See [frequently asked questions](https://docs.mattermost.com/overview/faq.html#mattermost-source-available-license) to learn more.

Although a valid Mattermost Enterprise Edition License is required if using this plugin in production, the [Mattermost Source Available License](LICENSE) allows you to compile and test this plugin in development and testing environments without a Mattermost Enterprise Edition License. As such, we welcome community contributions to this plugin.

If you're running an Enterprise Edition of Mattermost and don't already have a valid license, you can obtain a trial license from **System Console > Edition and License**. If you're running the Team Edition of Mattermost, including when you run the server directly from source, you may instead configure your server to enable both testing (`ServiceSettings.EnableTesting`) and developer mode (`ServiceSettings.EnableDeveloper`). These settings are not recommended in production environments.

Features

• Sync Keycloak groups or roles with Mattermost groups.
• Configurable mapping type: use Keycloak groups or roles as the source for Mattermost groups.
• Sync groups with teams or channels.
• Assign Mattermost group memberships to users on sign in through SAML based on the group or role memberships in their SAML assertion.

Requirements

• Mattermost Server v10.9 or higher.
• A valid Mattermost Enterprise Edition license.

Development guide

1. Run Keycloak locally with Mattermost by adding it to your ENABLED_DOCKER_SERVICES, see our SAML setup guide here.
2. Follow our plugin setup guide [./docs/INSTALL.md](./docs/INSTALL.md