Skip to main content

SAML2 Authentication

Project description

Odoo Community Association

SAML2 Authentication

Beta License: AGPL-3 OCA/server-auth Translate me on Weblate Try me on Runboat

Let users log into Odoo via an SAML2 identity provider.

This module allows to deport the management of users and passwords in an external authentication system to provide SSO functionality (Single Sign On) between Odoo and other applications of your ecosystem.

Benefits:

  • Reducing the time spent typing different passwords for different accounts.

  • Reducing the time spent in IT support for password oversights.

  • Centralizing authentication systems.

  • Securing all input levels / exit / access to multiple systems without prompting users.

  • The centralization of access control information for compliance testing to different standards.

Table of contents

Installation

This addon requires the python module pysaml2.

pysaml2 requires the binary xmlsec1 (on Debian or Ubuntu you can install it with apt-get install xmlsec1)

Configuration

To use this module, you need an IDP server, properly set up.

  1. Configure the module according to your IdP’s instructions (Settings > Users & Companies > SAML Providers).

  2. Pre-create your users and set the SAML information against the user.

By default, the module let users have both a password and SAML ids. To increase security, disable passwords by using the option in Settings. Note that the admin account can still have a password, even if the option is activated. Setting the option immediately remove all password from users with a configured SAML ids.

If all the users have a SAML id in a single provider, you can set automatic redirection in the provider settings. The autoredirection will only be done on the active provider with the highest priority. It is still possible to access the login without redirection by using the query parameter disable_autoredirect, as in https://example.com/web/login?disable_autoredirect= The login is also displayed if there is an error with SAML login, in order to display any error message.

If you are using Office365 as identity provider, set up the federation metadata document rather than the document itself. This will allow the module to refresh the document when needed.

Usage

Users can login with the configured SAML IdP with buttons added in the login screen.

Known issues / Roadmap

  • clean up auth_saml.request

Changelog

18.0.1.0.3 (2025-09-11)

Features

  • When using attribute mapping, only write value that changes. Not writing the value systematically avoids getting security mail on login/email when there is no real change.

18.0.1.0.2 (2025-05-13)

Bugfixes

  • Avoid redirecting when there is a SAML error.

18.0.1.0.0

Initial migration for 18.0.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • XCG Consulting

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

vincent-hatakeyama

This module is part of the OCA/server-auth project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odoo_addon_auth_saml-18.0.1.1.0.2-py3-none-any.whl (77.7 kB view details)

Uploaded Python 3

File details

Details for the file odoo_addon_auth_saml-18.0.1.1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_auth_saml-18.0.1.1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 86b0d47ce7709bdc5ded9bf0a1d22e85e337e83209a4018e0617ab7b9b0b3173
MD5 2891c183795ce9d91dfac4658ea16cb0
BLAKE2b-256 29f9ed0b2916c90cd63064cb41bc868a98fafa43b26fc084b1f7d80bf4fe8162

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page