Skip to content

Commit 185c7c3

Browse files
committed
Add version information for OIDC Provider
1 parent 3fb67ae commit 185c7c3

2 files changed

Lines changed: 10 additions & 7 deletions

File tree

content/en/docs/appstore/modules/oidc-provider.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ To return requested scopes to your client app, you need to perform the following
214214
1. Create a new scope for every user role which is implemented in your client apps. You can identify the user role in one of two ways:
215215

216216
1. use the **Name** as the user role in your client app.
217-
1. use the UUID of the user role in your client app.
217+
1. From version 1.1.0 you can also use the UUID of the user role in your client app.
218218

219219
The benefit of this second approach is that it avoids ‘scope collision’. In other words, you avoid having confusion between user roles with the same name but in different apps.
220220

@@ -250,6 +250,9 @@ The scopes you configure are not added automatically to the "scopes_supported" a
250250
1. In the connected apps, select the following microflows in the [OIDC SSO](/appstore/modules/oidc/) module to let you app apply the assigned user roles to the end-users:
251251

252252
* `UserProvisioning_StandardOIDC` as the user provisioning microflow
253+
254+
This is available in version 2.3.0 and above of the OIDC SSO module. For versions below this, you will need to write a custom user provisioning microflow.
255+
253256
* `OIDC.Default_OIDCProvider_TokenProcessing_CustomATP` as the **custom AccessToken processing microflow** for access token parsing
254257

255258
##### 3.3.3.2 Configuration of the OIDC Provider to Propagate the End-User’s Identity with Custom Claims{#propagate-custom-claims}
@@ -260,7 +263,7 @@ To pass this additional information, you need to create custom claims. You can d
260263

261264
1. Create a microflow which returns a value to the claim.
262265

263-
You can also pass an object from the Domain Model as the custom claim in an ID-token. To do this, your microflow should return the object.
266+
From version 1.1.0, you can also pass an object from the Domain Model as the custom claim in an ID-token. To do this, your microflow should return the object.
264267

265268
The ID-token will be a nested JSON structure with the name of the object as the key and a list of attribute names of your object as the keys and the attribute values as the values.
266269

@@ -460,7 +463,7 @@ Where there is no IAM brokering functionality, the administrator can create end-
460463

461464
For situations where the Centralized Authorization concept is used (see [Centralized Authorization](#centralized-auth), above), the OIDC Provider module uses the ‘scope’ claim in both the ID and Access token to communicate assigned user roles to connected Mendix apps. The scope parameter one of the following the formats:
462465

463-
* `mx:app:userrole:{user-role-UUID}`, where `{user-role-UUID}` is the UUID of the role in the connected app
466+
* `mx:app:userrole:{user-role-UUID}`, where `{user-role-UUID}` is the UUID of the role in the connected app (version 1.1.0 and above)
464467
* `{user-role}`, where `{user-role}` is the name of the user role
465468

466469
These are set up in [Configuration of the OIDC Provider for Centralized Authorization with Scopes](#configure-scopes). Multiple scopes will be separated by spaces.

content/en/docs/appstore/modules/oidc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ Alternatives to using OIDC SSO for managing single sign on are:
4444
* Supports SSO login with one or multiple OIDC/OAuth-compatible IdPs.
4545
* Easy configuration, by leveraging the so-called well-known discovery endpoint at your IdP.
4646
* For example, PKCE will be used automatically if it is detected.
47-
* Configuration can be controlled through constants set during your deployment (Version 2.3.0 and above).
47+
* Configuration can be controlled through constants set during your deployment (version 2.3.0 and above).
4848
* Helper microflows (DELETE, GET, PATCH, POST, and PUT) which call an API with a valid token (and automate the token refresh process).
4949
* Supports multiple OIDC IdPs by allowing configuration of user provisioning and access token parsing microflows per IdP.
50-
* Supports Authentication Context Class Reference (ACR) to allow your app to suggest the desired method or level of authentication for user login to the Identity Provider (IDP) (Version 2.3.0 and above).
50+
* Supports Authentication Context Class Reference (ACR) to allow your app to suggest the desired method or level of authentication for user login to the Identity Provider (IDP) (version 2.3.0 and above).
5151
* Supports responsive web applications, a.k.a. browser based applications.
5252
* Works with the Mendix DeepLink module.
5353
* Built primarily in standard Mendix components (minimal Java) to allow for easy customization and ongoing development.
@@ -67,7 +67,7 @@ For readers with more knowledge of the OAuth and OIDC protocol.
6767

6868
* Stores an access token for each end-user that can be used to make API calls on their behalf.
6969
* Can be configured to use either client_secret_post or client_secret_basic as the client authentication method. Both make use of the client-id and client-secret as configured at the IdP.
70-
* Supports ACR in authorization requests. The ACR in OIDC protocol is used to indicate the desired level of assurance or strength of authentication during the authentication process. It allows the relying party (your application) to request a specific level of authentication assurance from the identity provider (IdP) (Version 2.3.0 and above).
70+
* Supports ACR in authorization requests. The ACR in OIDC protocol is used to indicate the desired level of assurance or strength of authentication during the authentication process. It allows the relying party (your application) to request a specific level of authentication assurance from the identity provider (IdP) (version 2.3.0 and above).
7171

7272
#### 1.2.2 Limitations
7373

@@ -278,7 +278,7 @@ To configure Amazon Cognito for the OIDC SSO module, follow these steps:
278278

279279
### 5.2 OIDC Client Configuration{#client-configuration}
280280

281-
You can configure your OIDC client using the app pages – see [General OIDC Clients](#general-oidc), [Microsoft Azure AD Client Configuration](#azure), and [Amazon Cognito Client Configuration](#cognito), below. In Version 2.3.0 and above, you can also use constants to configure your app at deployment time – see [Automated Deploy-time SSO Configuration](#deploy-time), below.
281+
You can configure your OIDC client using the app pages – see [General OIDC Clients](#general-oidc), [Microsoft Azure AD Client Configuration](#azure), and [Amazon Cognito Client Configuration](#cognito), below. In version 2.3.0 and above, you can also use constants to configure your app at deployment time – see [Automated Deploy-time SSO Configuration](#deploy-time), below.
282282

283283
#### 5.2.1 General OIDC Clients {#general-oidc}
284284

0 commit comments

Comments
 (0)