To configure the Valsight application to use the OpenID Connect SSO, edit conf/config.yml and restart the server after making changes.
|Configuration Key (openIdConnect →)||Description||Example Value||Default Value|
|Whether OpenID Connect authentication should be used or not|
providerApplication → clientId
|OAuth 2.0 Client Identifier valid at the Authorization Server|
providerApplication → clientSecret
|Client Secret token, provided by the Authorization Server|
providerApplication → issuer
|Identifier for the Issuer of the authorization response.||https://my-oidc.com/||n/a|
providerApplication → acr_values
Allows to pass additional authentication related information to the user service.
*Available since: 3.7.0
providerEndpoints → userAuthorizationUrl
|The Authorization endpoint of the OpenID Connect flow||n/a|
providerEndpoints → accessTokenUrl
|The Token endpoint of the OpenId Connect flow||n/a|
providerEndpoints → jwkUrl
|The endpoint that contains certificates to verify the token||n/a|
|loginSuccessfulUrl||The absolute URL (starting with http(s)) of the application's main page. The user will be redirected there after a successful login.|
|scope||List of comma separated scopes if we want fetch additional claims. The scope 'openid' will always be present, whether it is included in the configuration list or not.||email,profile||openid|
|userProfileMapping → username||The claim used to uniquely identify an user. It must always be present in the provider's response and unique per user.||preferred_username||Sub|
|userProfileMapping → email|
This claim that contains the user's e-mail address.
|userProfileMapping → fullName|
The claim that contains the user's full name.
When the Valsight app is running behind a reverse proxy and the app server's port is not exposed directly (e.g. for purposes of HTTPS configuration), this URL is required. It is used by the Authorization Server to redirect the user back to the application after the successful login.
|mandatoryClaims → claim → claimValue|
This is used to customize the requested presence and values of claims beyond the ones requested by the OpenID Connect specification.
Each claim configured here must be present in the provider's response and also have the specified value. If claim has multiple values in the response (e. g. a list of groups the users belongs to) then one of the values in the response must be an exact match to the configured value.
This configuration option enables OpenID Connect to determine which groups users belong to. If this field is not present or if it is empty, the groups must be managed internally in the application. If we set a value of 'groupsClaim' we turn this functionality on. The value of 'groupsClaim' should be a an claim name that contains the OpenID Connect provided groups.
The group matching happens as follows:
Important: this functionality never automatically deletes groups in the application
*Available since: 5.0.0
Forces the application to always use the 'API to fetch the user's groups. It has no effect if 'groupsClaim' is not enabled.
*Available since: 5.7.6
If this flag is set to true, the applications session will expire when the authentication token expires.
If this flag is set to false (default) then the application will manage sessions as as normal.
The OpenID Connect providers also have restrictions on which URLs are allowed to use the provider and where the provider is allowed to redirect to. The URL that the provider is redirecting to in our application is: <APPROOT>/v1/openIdConnect.
For logging purpose, add in the log level view ( Configuration UI), the following package:
- Logger: com.valsight.authentication.openidconnect
- Logger: com.valsight.services.sso.SSOService (since 5.7.0)
- Level: DEBUG