You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/appstore/use-content/platform-supported-content/modules/oidc.md
+30-4Lines changed: 30 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -521,15 +521,43 @@ You can set up custom user provisioning by setting the following constants. You
521
521
522
522
#### Runtime Configuration of End-user Onboarding{#custom-provisioning-rt}
523
523
524
+
By default, users are provisioned by [Default User Provisioning Configuration](#default). Optionally, you can customize user provisioning by [Modifying Default Attribute Mapping](#modify-default), [User Provisioning Using Your Custom User Entity](#custom_user_entity), or [User Provisioning Using a Microflow at Runtime](#microflow-at-runtime).
525
+
524
526
You can set up just-in-time user provisioning as follows:
525
527
526
528
1. Sign in to the running app with an administrator account.
527
529
2. Navigate to the `OIDC.OIDC_Client_Overview` page which is set up in the app navigation.
528
530
3. In the **IdPs for SSO and API security** tab, click **New** and access the **UserProvisioning** tab.
529
531
532
+
Below fields are available in the **UserProvisioning** tab for the User Provisioning configuration.
533
+
534
+
***Custom user Entity (extension of System.User)** – the Mendix entity where you will store and look up the user account. If you are using the [Administration module](https://marketplace.mendix.com/link/component/23513), this would be `Administration.Account`.
535
+
***The attribute where the user principal is stored** – unique identifier associated with an authenticated user.
536
+
***Allow the module to create users** – this enables the module to create users based on configurations of JIT user provisioning and attribute mapping. When disabled, it will still update existing users. However, for new users, it will display an exception message in the log.
537
+
* By default, the value is set to ***Yes***.
538
+
***User role** (optional) – the role which will be assigned to newly created users. This is optional and will be applied to all IdPs. You can select any user role as a default or keep the field empty. If you need additional user roles, use Access Token Parsing microflow to assign multiple roles.
539
+
* By default, the value is set to ***User***.
540
+
***User Type** – this allows you to configure end-users of your application as internal or external. It is created upon the creation of the user and updated each time the user logs in.
541
+
* By default, the value is set to ***Internal***.
542
+
543
+
Under **Attribute Mapping**, for each piece of information you want to add to your custom user entity, select an **IdP Attribute** (claim) and specify the **Configured Entity Attribute** where you want to store the information.
544
+
545
+
Note the following:
546
+
547
+
* You cannot use the IdP claim which is the primary attribute identifying the user and you cannot use the attribute you set in **The attribute where the user principal is stored**.
548
+
* You can map only one IdP claim to a Custom user Entity attribute.
549
+
* The **IdP Attribute** is one of the fixed claims supported by the OIDC SSO module.
550
+
* IdP Attributes(Claims) cannot be of type enum, autonumber, or an association.
551
+
552
+
Optionally, you can select the microflow in the **Custom UserProvisioning** field to use custom logic for user provisioning. For more information, see the [User Provisioning Using a Microflow at Runtime](#microflow-at-runtime) section below.
553
+
554
+
{{% alert color="info" %}}
555
+
If you are using module version 3.2.0 and below, you will need to refresh the module containing your microflow as described in the [Installing Mx Model Reflection](/appstore/modules/oidc/#mxmodelreflection) and select the microflow in the **Custom UserProvisioning** field.
556
+
{{% /alert %}}
557
+
530
558
##### Default User Provisioning Configuration{#default}
531
559
532
-
The User Provisioning configuration fields are available in the **UserProvisioning** tab. In default configuration, the custom user entity is set as `Administration.Account`, the principal attribute is set as `Name`, and the default attribute mapping is provided.
560
+
In default configuration, the custom user entity is set as `Administration.Account`, the principal attribute is set as `Name`, and the default attribute mapping is provided.
@@ -547,7 +575,7 @@ You can set up custom JIT user provisioning as follows:
547
575
548
576
***Custom user Entity (extension of System.User)** – the Mendix entity where you will store and look up the user account. If you are using the [Administration module](https://marketplace.mendix.com/link/component/23513), this would be `Administration.Account`.
549
577
***The attribute where the user principal is stored** – unique identifier associated with an authenticated user.
550
-
***Allow the module to create users** – this enables the module to create users based on configurations of JIT user provisioning and attribute mapping. When disabled, it will still update existing users. However, for new users, it will display an exception message stating that the login action was successful but no user has been configured.
578
+
***Allow the module to create users** – this enables the module to create users based on configurations of JIT user provisioning and attribute mapping. When disabled, it will still update existing users. However, for new users, it will display an exception message in the log.
551
579
* By default, the value is set to ***Yes***.
552
580
***User role** (optional) – the role which will be assigned to newly created users. This is optional and will be applied to all IdPs. You can select any user role as a default or keep the field empty. If you need additional user roles, use Access Token Parsing microflow to assign multiple roles.
553
581
* By default, the value is set to ***User***.
@@ -571,8 +599,6 @@ If you are using module version 3.2.0 and below, you will need to refresh the mo
571
599
572
600
4. Click **Save** to save the configuration.
573
601
574
-
By default, users are provisioned by [Default User Provisioning Configuration](#default). Optionally, you can customize user provisioning by [Modifying Default Attribute Mapping](#modify-default), [User Provisioning Using Your Custom User Entity](#custom_user_entity), or [User Provisioning Using a Microflow at Runtime](#microflow-at-runtime).
575
-
576
602
{{% alert color="info" %}}
577
603
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.
0 commit comments