SAML

The Jmix SAML add-on enables SAML 2.0 authentication in Jmix applications.

Installation

For automatic installation through Jmix Marketplace, follow instructions in the Add-ons section.

For manual installation add the following dependency to your build.gradle:

implementation 'io.jmix.saml:jmix-saml-starter'

Default Jmix SAML Configuration

With the default Jmix SAML configuration:

  • Non-authenticated users are redirect to the identity provider login page.

  • A SAML-backed user is created in memory after authentication. An instance of DefaultJmixSamlUserDetails is placed in the security context; users are not persisted to the database.

  • User attributes are not mapped automatically.

  • User role codes are taken from the Role attribute in the SAML assertion. Resource and row-level roles with those codes are then applied to the user authentication object.

Follow the Keycloak SAML Setup to configure this default behavior. See the additional setup instructions extending the default configuration.