Repository navigation
SAML: add more explaination for IdP configurations - #12048
Open
Karuna-Mendix wants to merge 6 commits into
Open
Karuna-Mendix wants to merge 6 commits into
Karuna-Mendix wants to merge 6 commits into
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
JaapF
reviewed
Oct 9, 2026
JaapF
reviewed
Oct 12, 2026
JaapF
reviewed
Oct 12, 2026
JaapF
reviewed
Oct 15, 2026
| * **Easy configuration** – Uses mostly the defaults provided by the SAML module and supports a single IdP. | ||
| * **Custom configuration** – Uses a custom microflow defined at design time. Supports multiple IdPs and additional customization. | ||
|
|
||
| From SAML module version 4.2.0, the `IdPConfiguration_MicroflowName` constant determines which microflow provides the IdP configuration. Its default value is `SAML.Default_CreateIDPConfiguration`. For custom configuration, specify a custom microflow that returns a list of IdP configurations. |
There was a problem hiding this comment.
Maybe we should extend by saying that SAML.Default_CreateIDPConfiguration activates the runtime configuration mechanism.
Do you think this is the best place in the document to clarify this?
JaapF
reviewed
Oct 15, 2026
| There are two deployment-managed options: | ||
|
|
||
| * **Easy configuration** – Uses mostly the defaults provided by the SAML module and supports a single IdP. | ||
| * **Custom configuration** – Uses a custom microflow defined at design time. Supports multiple IdPs and additional customization. |
There was a problem hiding this comment.
Custom configuration – Uses a custom microflow defined at design time to create one or multiple IdP configurations when the application starts. It allows you to customize IdP-specific settings while continuing to use applicable defaults provided by the SAML module.
JaapF
reviewed
Oct 15, 2026
Comment on lines
+91
to
+93
| There are two deployment-managed options: | ||
|
|
||
| * **Easy configuration** – Uses mostly the defaults provided by the SAML module and supports a single IdP. |
There was a problem hiding this comment.
Easy configuration – Uses configuration values defined at design time or overridden at deploy time to create a single IdP configuration when the application starts. It uses sensible defaults provided by the SAML module.
JaapF
reviewed
Oct 15, 2026
|
|
||
| From SAML module version 4.2.0, the `IdPConfiguration_MicroflowName` constant determines which microflow provides the IdP configuration. Its default value is `SAML.Default_CreateIDPConfiguration`. For custom configuration, specify a custom microflow that returns a list of IdP configurations. | ||
|
|
||
| ### Runtime Configuration |
There was a problem hiding this comment.
heading should be "Manual Configuration through the Administration UI"
JaapF
reviewed
Oct 15, 2026
|
|
||
| ### Runtime Configuration | ||
|
|
||
| With runtime configuration, an administrator configures one or more IdPs through the Administration UI after deployment. This lets you deviate from the defaults and makes it easier to configure and test SAML settings iteratively without redeploying the application. It is particularly useful during initial setup and troubleshooting. |
There was a problem hiding this comment.
Maybe: "Manual configuration – Configure one or multiple IdPs manually through the Administration UI after the application has been deployed. This supports interactive configuration and testing without redeploying the application."
JaapF
reviewed
Oct 15, 2026
|
|
||
| The following table compares the easy, custom, and runtime configuration options. | ||
|
|
||
| | | [Easy](#easy-flow) | [Custom](#non-default) | [Runtime](#runtime-config) | |
JaapF
reviewed
Oct 15, 2026
| | Best suited for | Single IdP, automation and reuse | Multiple IdPs or customized configuration, with automation and reuse | Interactive setup and iterative configuration | | ||
| | Design time | Set default values for the [eight configuration constants](#setup-eight-constants) in the app | Define custom configuration microflow | No IdP configuration required at design time | | ||
| | Deploy time | Override the design-time values where environment-specific settings are required | Provide environment-specific settings | No IdP configuration required at deploy time | | ||
| | Runtime | IdP configuration is created at startup. Changes made through the Administration UI are overwritten at restart. | IdP configuration is created at startup. Changes made through the Administration UI are overwritten at restart. | Configure through Administration UI | |
There was a problem hiding this comment.
improved row:
At application startup | IdP configuration is created from the configured values | Custom microflow creates one or multiple IdP configurations | Existing manually managed configuration is used
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://mendix.slack.com/archives/C033TNDL396/p1791269751037679