Skip to content

Commit 2679c4d

Browse files
Merge pull request #10975 from mendix/kv-saml-updates
SAML updates
2 parents 2b159d9 + e7f4281 commit 2679c4d

6 files changed

Lines changed: 389 additions & 376 deletions

File tree

content/en/docs/marketplace/platform-supported-content/modules/SAML/_index.md

Lines changed: 4 additions & 314 deletions
Large diffs are not rendered by default.

content/en/docs/marketplace/platform-supported-content/modules/SAML/advanced-configuration.md

Lines changed: 1 addition & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Advanced SAML Configuration and Troubleshooting"
33
url: /appstore/modules/saml/advanced-configuration
44
linktitle: "Advanced Configuration and Troubleshooting"
5-
weight: 50
5+
weight: 40
66
description: "Describes the advanced configuration and troubleshooting for the SAML module."
77
---
88

@@ -63,56 +63,6 @@ The resources folder contains the *SAMLConfig.properties* file, and through this
6363

6464
If you are using a custom URL, see [How Do I Get my SAML Metadata or CommunityCommons.GetApplicationUrl to Use the Custom URL?](/developerportal/deploy/custom-domains/#use-custom-url) in the *Custom Domains* documentation.
6565

66-
### Using Deep Links
67-
68-
{{% alert color="info" %}}
69-
The Deep Link module has been deprecated from Studio Pro 10.6.0 and replaced by [page URLs](/refguide/page-properties/#url) and [microflow URLs](/refguide/microflow/#url). For instructions on migrating to page and microflow URLs, see the [Using Page and Microflow URLs with SAML](#page-microflow-url-saml) section below.
70-
{{% /alert %}}
71-
72-
If end-users who use the deep link do not yet have a session in your app, the deep link can trigger the SSO process. If successful, the end-user will be automatically redirected back to the deep link.
73-
74-
For more information on using the Deep Link module (with Mendix 8 and 9), see the [Using Deep Link Module](#using-deeplink) section below.
75-
76-
#### Using Page and Microflow URLs with SAML{#page-microflow-url-saml}
77-
78-
Page URLs and Microflow URLs are supported with SAML for Mendix version 10.6 and above. To do this, follow the steps below:
79-
80-
1. In the **Runtime** tab of the **App Settings**, configure the page **URL prefix** to **link** instead of the default **P** to maintain compatibility with existing URLs.
81-
2. Ensure to remove the Deep Link module from your app to start the app successfully. For more information, see the [Migrating to Page and Microflow URLs](/appstore/modules/deep-link/#migrate-page-micro) section of the *Deep Link*.
82-
83-
##### Steps for SAML Versions Above v3.6.17 and v4.0.1
84-
85-
1. To use the Page URL functionality, replace the content of *login.html* with the content of *login-with-mendixsso-automatically.html* (located in the **resources** > **mendixsso** > **templates** folder) without changing the file name.
86-
2. To implement the SSO redirection, replace the code in the `<script>` tag on your login page (for example, *login.html*) with the following code:
87-
88-
* For automatic redirection: use `window.onload` to automatically redirect users to the SSO login page.
89-
90-
```javascript
91-
window.onload = function () {
92-
const returnURL = encodeURIComponent(window.location.search + window.location.hash);
93-
location.replace('/SSO/login?cont=' + returnURL);
94-
};
95-
```
96-
97-
* For manual redirection: add an onclick event to the button that manually triggers the SSO login.
98-
99-
```javascript
100-
function SSOlogin() {
101-
const returnURL = encodeURIComponent(window.location.search + window.location.hash);
102-
location.replace('/SSO/login?cont=' + returnURL);
103-
}
104-
```
105-
106-
Once the above changes are applied, end users can directly navigate to the desired page. If not logged in, they will be redirected to the IdP login page for authentication. After successful login, they will be directed to the desired page using page and microflow URLs.
107-
108-
#### Using the Deep Link Module{#using-deeplink}
109-
110-
When using the SAML module with the Deep link Module (for Mendix 8 and 9), you need to set the `LoginLocation` constant of the Deeplink module to `/SSO/login?f=true&cont=` to redirect the user to the original deep link location after a successful login.
111-
112-
The DeepLink module does not have full support for multiple IdPs, so it can only trigger logins at one IdP. You can specify which IdP should be used by adding the alias (`MyIdPAlias`) to the `LoginLocation`: `/SSO/login?_idp_id={MyIdPAlias}&cont=`.
113-
114-
If you are using version 6.1.0 or above of the Deep Link module, you should also set the `EnableLeadingSlash` constant to *False*. This prevents users from being redirected to an invalid deep link location.
115-
11666
## Testing and Troubleshooting
11767

11868
When testing and debugging the configuration, an option is to view the messages in the log files. A detailed cause of the failure will be printed in case something goes wrong.

content/en/docs/marketplace/platform-supported-content/modules/SAML/idp-attributes.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: "Reference Guide for SAML IdP Configuration"
33
url: /appstore/modules/saml/idp-attributes
44
linktitle: "SAML IdP Configuration"
5-
weight: 10
5+
weight: 20
66
description: "Describes the list of IdP Attributes for the SAML module"
77
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
88
---
99

1010
## Introduction
1111

12-
This document provides you with a detailed description of each IdP attribute and its default value for deploy-time configuration. You need to use these attributes when configuring the SAML module to create the IdP configuration. For more details, see [Non-default Configuration](/appstore/modules/saml/#non-default).
12+
This document provides you with a detailed description of each IdP attribute and its default value for deploy-time configuration. You need to use these attributes when configuring the SAML module to create the IdP configuration. For more details, see [Non-default Configuration](/appstore/modules/saml/installation-configuration/#non-default).
1313

1414
## Identity Configuration
1515

@@ -31,20 +31,20 @@ Using artifact binding for SAML responses at the SAML IdP is only available in t
3131
* v3.3.0/v3.3.1 and above for Mendix 9 and 10
3232
* v2.3.0 and above for Mendix 8
3333

34-
`POST_BINDING` is the default value when using an [Easy Default Flow](/appstore/modules/saml/#easy-flow).
34+
`POST_BINDING` is the default value when using an [Easy Default Flow](/appstore/modules/saml/installation-configuration/#easy-flow).
3535

3636
### Use AssertionConsumerService Concept
3737

3838
In most cases (for example, with Entra ID), you do not want to use the AssertionConsumerService concept in requests. Some IdPs, however, require requests to include an AssertionConsumerServiceIndex. This refers to the definition of the Assertion Consumer Service in the SP metadata.
3939

4040
* If the **Use AssertionConsumerService Concept** is set to `No…` then Auth-Request contains the `AssertionConsumerServiceURL` and `ProtocolBinding` attributes.
4141
* If the **Use AssertionConsumerService Concept** is set to `Yes…` then Auth-Request contains only the ‘`AssertionConsumerServiceIndex`’ attribute.
42-
By default, it is `No` when using an [Easy Default Flow](/appstore/modules/saml/#easy-flow).
42+
By default, it is `No` when using an [Easy Default Flow](/appstore/modules/saml/installation-configuration/#easy-flow).
4343

4444
### Assertion Consumer Service Index
4545

4646
Set the **Assertion consumer service index** to the value you want to use for `AssertionConsumerServiceIndex` in both the Auth-Request and the SP-Metadata.
47-
The configured binding will be included in the SP metadata, as indicated in the [URLs](/appstore/modules/saml/#urls) section. The default value is `0` for the deploy time configuration.
47+
The configured binding will be included in the SP metadata, as indicated in the [URLs](/appstore/modules/saml//installation-configuration/#urls) section. The default value is `0` for the deploy time configuration.
4848

4949
## Attribute Consuming Service
5050

@@ -53,7 +53,7 @@ In the **Attribute Consuming Service** tab, you can configure your app using the
5353
You can set up two sets of attributes by adding new attributes, editing existing attributes, or removing selected attributes. These will be provided at different times. Those listed under **I want to request attribute(s) at my IDP during initial login** will be returned when the end-user initially signs in. Those listed under **I want to request attribute(s) at my IDP during in-session login** will be returned during [In-session Authentication](#in-session).
5454
Although the typical use case for requesting attributes is to obtain information about the user, you can request an attribute with a specific value. In this case, you can configure the optional Attribute value that must be returned.
5555

56-
When using an [Easy Default Flow](/appstore/modules/saml/#easy-flow), disable both initial and in-session login options.
56+
When using an [Easy Default Flow](/appstore/modules/saml/installation-configuration/#easy-flow), disable both initial and in-session login options.
5757

5858
Requesting user attributes at the SAML IdP is only available in the following versions of the module (depending on which Mendix version you are using)
5959

@@ -69,7 +69,7 @@ Requesting user attributes at the SAML IdP is only available in the following ve
6969
* **What algorithm do you want to use to sign messages** (or *Encryption method*) – `SHA1 - RSA`, or `SHA256 - RSA`
7070
* **Encryption key length** – 1024 or 2048 bits
7171

72-
When using an [Easy Default Flow](/appstore/modules/saml/#easy-flow), default values are `SHA256 - RSA` and 2048 bits
72+
When using an [Easy Default Flow](/appstore/modules/saml/installation-configuration/#easy-flow), default values are `SHA256 - RSA` and 2048 bits
7373

7474
Enabling encryption has the following effects on messages being exchanged:
7575

0 commit comments

Comments
 (0)