Skip to content

Commit c2c5147

Browse files
committed
moving User Provisioning fields
1 parent 007883a commit c2c5147

1 file changed

Lines changed: 13 additions & 32 deletions

File tree

  • content/en/docs/appstore/use-content/platform-supported-content/modules

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

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -551,53 +551,34 @@ Note the following:
551551

552552
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.
553553

554+
{{< figure src="/attachments/appstore/platform-supported-content/modules/oidc/default_provisioning.png" >}}
555+
554556
{{% alert color="info" %}}
555557
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.
556558
{{% /alert %}}
557559

558560
##### Default User Provisioning Configuration{#default}
559561

562+
If the standard configuration meets your needs and your application does not have special user management requirements, you can use the default User Provisioning.
563+
560564
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.
561565

562-
{{< figure src="/attachments/appstore/platform-supported-content/modules/oidc/default_provisioning.png" >}}
566+
| IdP Attribute | Configured Entity Attribute |
567+
| -------------------- | --------------------------- |
568+
| email | Email |
569+
| name | FullName |
570+
| sub | Name |
563571

564-
###### Modifying Default Attribute Mapping{#modify-default}
572+
##### Modifying Default Attribute Mapping{#modify-default}
565573

566-
Optionally, you can change the default **IdP Attribute** or the **Configured Entity Attribute**, by editing the mapping in the **Attribute Mapping** section within the **UserProvisioning** tab.
574+
You may need a different or custom attribute mapping, for example, if you are configuring OIDC SSO and SCIM together and need a common identifier. In this case, you can modify the default attribute mapping.
575+
To do so, change the default **IdP Attribute** or the **Configured Entity Attribute**, by editing the mapping in the **Attribute Mapping** section within the **UserProvisioning** tab.
567576

568577
##### User Provisioning Using Your Custom User Entity{#custom_user_entity}
569578

570579
If you want to use your custom user entity which is a specialization of the `System.User` entity to store user information, select it in the **Custom user Entity (extension of System.User)** field by replacing the `Administration.Account` entity.
571580

572-
You can set up custom JIT user provisioning as follows:
573-
574-
1. Set up the following fields:
575-
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`.
577-
* **The attribute where the user principal is stored** – unique identifier associated with an authenticated user.
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.
579-
* By default, the value is set to ***Yes***.
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.
581-
* By default, the value is set to ***User***.
582-
* **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.
583-
* By default, the value is set to ***Internal***.
584-
585-
2. 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.
586-
587-
Note the following:
588-
589-
* 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**.
590-
* You can map only one IdP claim to a Custom user Entity attribute.
591-
* The **IdP Attribute** is one of the fixed claims supported by the OIDC SSO module.
592-
* IdP Attributes(Claims) cannot be of type enum, autonumber, or an association.
593-
594-
3. 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.
595-
596-
{{% alert color="info" %}}
597-
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.
598-
{{% /alert %}}
599-
600-
4. Click **Save** to save the configuration.
581+
To configure custom JIT user provisioning, set up the fields listed in the [Runtime Configuration of End-user Onboarding](#custom-provisioning-rt) section above and save the configuration.
601582

602583
{{% alert color="info" %}}
603584
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

Comments
 (0)