Skip to content

Commit 3a42ab5

Browse files
Merge pull request #9594 from mendix/kv-saml-updates
SAML: remove the constants
2 parents 6b3090f + 5a55332 commit 3a42ab5

File tree

1 file changed

+5
-25
lines changed
  • content/en/docs/appstore/use-content/platform-supported-content/modules/SAML

1 file changed

+5
-25
lines changed

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

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,8 @@ The following constants in the **IdP Configuration** > **USE_ME** folder help co
267267
268268
If you provide values for the above constants, the SAML module will automatically generate the required/default additional configurations with the help of the `Default_CreateIDPConfiguration` microflow.
269269
270+
`SP_Entity` is an optional constant in the SP Metadata that represents the SP Entity.
271+
270272
#### Deploy the Application and Login with SSO{#deploy-application}
271273
272274
After configuring the eight constants, you need to deploy the application. For details, see the [Deploying the App](/developerportal/deploy/mendix-cloud-deploy/deploying-an-app/) section in the *Deploying an App to Mendix Cloud*. Once deployed, you can now log in to your application using SSO.
@@ -333,7 +335,7 @@ The below table shows you the different attributes and their values for quick re
333335
| **UseEncryption** | Enable better security for app | TRUE |
334336
| **EncryptionMethod** | This represents the Encryption Algorithm | SHA256 - RSA |
335337
| **EncryptionKeyLength** | This constant represents the Encryption length | 2048 bits |
336-
| Active | After completion of Idp config it will make the Toggle Active | true |
338+
| Active | After completion of IdP config it will make the Toggle Active | true |
337339
338340
Deploy the application and log in with the SSO. For more information, see the [Deploy the Application and Login with SSO](#deploy-application) section above.
339341
@@ -406,7 +408,7 @@ The following settings apply to the IdP configuration:
406408
407409
Initially, your app will not have any end-users. The SAML module provides so-called Just-In-Time (JIT) user provisioning. This means that an end-user will be created in your app when they log in for the first time. If you do not want JIT user provisioning, it is possible to disable it as described in the section [Custom User Provisioning at Runtime](#custom-provisioning-rt) below.
408410
409-
By default, end-users are provisioned using the Account object in the Administration module. If you need to use a custom user entity, you can do this via [Custom User Provisioning at Deploy Time](#custom-provisioning-dep) or [Custom User Provisioning at Runtime](#custom-provisioning-rt).
411+
By default, end-users are provisioned using the Account object in the Administration module. If you need to use a custom user entity, you can do this via [Custom User Provisioning at Runtime](#custom-provisioning-rt).
410412
411413
### Default User Provisioning
412414
@@ -422,31 +424,9 @@ If you create custom user entities as specializations of the `System.User` entit
422424
423425
If you connect multiple IdPs to your Mendix app, you can use separate custom user entities for each IdP, each with its own attribute mapping.
424426
425-
### Custom User Provisioning at Deploy Time{#custom-provisioning-dep}
426-
427-
{{% alert color="info" %}} This feature is available in version 4.0.0 and above {{% /alert %}}
428-
429-
You can set up custom user provisioning by setting constants when you deploy your app. This has the following limitations compared to setting up provisioning using a microflow or changing the settings at runtime:
430-
431-
* You will need to restart your app to apply changes to the constants
432-
* You cannot set custom mapping of IdP claims to attributes of your custom user entity
427+
### Disable MxAdmin at Deploy Time
433428
434-
You can set up custom user provisioning by setting the following constants. You can set default values when you build your app but can override these in the app's environment.
435-
436-
| Constant | Use | Notes | Example |
437-
| --- | --- | --- | --- |
438-
| CustomUserEntity | a custom user entity | in the form `modulename.entityname` – a specialization of `System.User` | `Administration.Account` |
439-
| PrincipalAttribute | the attribute holding the unique identifier of an authenticated user | | `Name` |
440-
| IdPAttribute | the IdP claim which is the unique identifier of an authenticated user | *Default* | `NameId` |
441-
| AllowcreateUsers | allows to create users in the application | *Optional* | `True` |
442-
| Userrole | the role which will be assigned to newly created users | *Optional* | `User` |
443-
| UserType | assigns user type to the created user | *Optional* | `Internal` |
444-
| CustomUserProvisioning | a custom microflow to use for user provisioning | *Optional* – in the form `modulename.microflowname` – the microflow name must begin with the string `CustomUserProvisioning` | `Mymodule.CustomUserProvisioningEntra` |
445-
| DisableMxAdmin | deactivates Mx admin | *Optional* | `True` |
446-
447-
{{% alert color="info" %}}
448429
You may have a requirement that users log in to your application only via SSO. However, when you deploy your app on the Mendix Cloud, the platform may still create an MxAdmin user with a local password. From version 2.1.0 of the UserCommons module, if the flag for the `DisableMxAdmin` constant is set to `True`, the MxAdmin user will be deactivated via the startup microflow `ASU_UserCommons_StartUp`.
449-
{{% /alert %}}
450430
451431
### Custom User Provisioning at Runtime{#custom-provisioning-rt}
452432

0 commit comments

Comments
 (0)