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/marketplace/platform-supported-content/modules/oidc.md
+13-4Lines changed: 13 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,9 +128,9 @@ The OIDC module requires your app to be using Mendix 9.0 or above.
128
128
129
129
It requires the following Marketplace modules to be included in your app:
130
130
131
-
*[Encryption](https://marketplace.mendix.com/link/component/1011) – see [Encryption](/appstore/modules/encryption/) documentation.
131
+
*[Encryption](https://marketplace.mendix.com/link/component/1011)(for version 4.3.0 and below) – see [Encryption](/appstore/modules/encryption/) documentation.
132
132
*[Community Commons](https://marketplace.mendix.com/link/component/170) – see [Community Commons](/appstore/modules/community-commons-function-library/) documentation.
133
-
*[Nanoflow Commons](https://marketplace.mendix.com/link/component/109515) – see [Nanoflow Commons](/appstore/modules/nanoflow-commons/) documentation.
133
+
*[Nanoflow Commons](https://marketplace.mendix.com/link/component/109515)(for version 4.3.0 and below) – see [Nanoflow Commons](/appstore/modules/nanoflow-commons/) documentation.
134
134
*[User Commons](https://marketplace.mendix.com/link/component/223053) (for version 3.0.0 and above)
135
135
136
136
{{% alert color="warning" %}}
@@ -205,7 +205,8 @@ This section provides an overview of updates for the OIDC SSO module across diff
205
205
206
206
| Mendix Version | OIDC SSO Module Version | Important Migration Changes | Additional Information |
207
207
| --- | --- | --- | --- |
208
-
| 10.24.0 and above | 4.3.0 | - | Supporting multi-domain and sub-path |
208
+
| 10.24.0 and above | 4.4.0 | Move the `Encryption.Encryptionkey` value to the `OIDC.Encryptionkey` constant. | Dependencies on the Encryption and Nanoflow Commons modules have been removed. <br> **Issued Tokens** tab has been removed from the OIDC Client Configuration page. |
209
+
| 10.24.0 and above | 4.3.0 | - | Supporting multi-domain and sub-path. |
209
210
| 10.24.0 and above | 4.2.1 | In version 4.2.1, automatic migration of the UserCommons has been removed. | Since migration steps were removed in 4.2.1, you must upgrade to OIDC SSO version 4.2.0 first to prevent data loss. This applies to the UserCommons, if you are migrating from any version below 3.0.0, always upgrade to 4.2.0 first, then move to the latest v4.2.1. |
210
211
| 10.21.01 and above | 4.2.0 | In version 4.2.0, the module no longer automatically executes the UserCommons migration in the startup microflow. The migration step has been moved to a dedicated microflow, which you can trigger via a widget. | The `ASU_STARTUP` microflow has been moved under the **USE_ME** folder. |
211
212
| 10.12.10 and above | 4.0.0 | Set `OIDC.ASU_OIDC_Startup` microflow as part of the after-startup microflow | From UserCommons 2.0.0, new users without IdP-specified time zone or language will use default App settings; existing users retain their previously set values. |
@@ -259,9 +260,15 @@ In addition, administrators will need to have access to configure OIDC and also
259
260
If you are testing phone web and phone web offline locally, use the URLs `http://localhost:8080/?profile=Phone` and
260
261
`http://localhost:8080/?profile=PhoneOffline`, respectively. For more information, see the [Example of profile selection](/refguide/mobile/introduction-to-mobile-technologies/progressive-web-app/#example-of-profile-selection) section of *Progressive Web App*.
261
262
263
+
Admins can view their own token using a snippet in their custom page. They can find this snippet under **OIDC > USE_ME > Snippet_Token_View**. The snippet displays the admin's decrypted and decoded Access token and ID token.
264
+
262
265
### Setting Encryption Key
263
266
264
-
Follow the instructions to [set an encryption key in the Encryption module](/appstore/modules/encryption/#configuration). The constant to set is called `Encryption.EncryptionKey` and should be a random value 32 characters long. This key will be used to encrypt and decrypt values.
267
+
Follow the instructions to [set an encryption key in the Encryption module](/appstore/modules/encryption/#configuration). For OIDC SSO V4.3.0 and below, set a constant called `Encryption.EncryptionKey` and assign it a random value 32-character value. Starting from version 4.4.0, set the encryption key in the `OIDC.Encryptionkey` constant using a random 32-character value. This key will be used to encrypt and decrypt values.
268
+
269
+
{{% alert color="info" %}}
270
+
While upgrading from V4.3.0 to V4.4.0 or above, ensure that any value currently stored in the `Encryption.Encryptionkey` is moved to the `OIDC.Encryptionkey` constant, otherwise, existing IdP client authentication will fail.
271
+
{{% /alert %}}
265
272
266
273
## IdP Configuration {#idpconfiguration}
267
274
@@ -1133,6 +1140,8 @@ Content - {"error":"invalid_client","error_description":"client authentication f
1133
1140
1134
1141
[Section 5.2 of RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2) indicates and clarifies all the possible error codes that may be returned.
1135
1142
1143
+
If you want to review tokens during troubleshooting, you can include the `Snippet_Token_View` snippet in a custom admin page; this allows you to see the json content.
1144
+
1136
1145
### Custom Microflow Implementation Should Be Required to Process Access_Token Roles
1137
1146
1138
1147
If you get the error message “Custom microflow implementation should be required to process Access_token roles” in the Mendix Studio Pro console logs, this indicates you have not completely implemented your custom microflow for parsing access tokens (`CustomATP_…`). See the section on [Dynamic Assignment of Userroles (Access Token Parsing)](#access-token-parsing).
0 commit comments