OpenID Integration

Overview

OpenID Connect (OIDC) is an open standard and decentralized authentication protocol. The OpenID module allows users to create accounts by selecting an OpenID identity provider and then use those accounts to sign on to any website that accepts OpenID authentication.

Version 9 Endpoints

Prerequisites:

• Preexisting OpenID Account
• Access to an OpenID API
• Installation of the OpenID module (to learn how to install a module, see Installing Modules)
  • Unlike most modules, the OpenID module is located with the identity provider modules under System > Security > Identity Providers.

Basic Configuration

1. Navigate to System > Settings and click OpenID Settings. Select the Enabled checkbox on the Edit Open Id Settings window and click ADD under Identity Providers.
2. Enter an appropriate name in the IdP Name field. The Client ID, Client Secret, and Discovery URL (Authority) fields can be obtained from an Identity Provider. The Discovery URL (Authority) usually ends with ".well-known/openid-configuration". After configuring all the appropriate fields, click OK.
   Be sure the information being inputted is correct. Many Identity Providers have an allowed list of redirect URIs. It may be necessary to add "http://decisions/Login" to this list. The required information may change between different Identity Providers.
   
3. Click the dropdown list under Primary Identity Provider and select the Identity Provider created. Click SAVE.
   When the Log OpenID Requests & Responses setting is enabled, requests and responses will be located at C:/Program Files/Decisions/Decisions Server/Logs/OpenID. 

   

4. In the File Explorer, navigate to C:\Program Files\Decisions\Decisions Server and open Settings.xml. 
   
5. Locate <EnableSingleSignOn> and set the value to true. 
6. Restart the Decisions Service service or IIS App Pool. If there is an active session, it might be logged in with a non-OpenID account. Log out or start a new session to be redirected to the identity provider. Once the identity provider has accepted the credentials, it will redirect to Decisions to log in with the OpenID account.
   

Login URL Parameter

This parameter is an authentication and authorization protocol built on top of OAuth 2.0. Users can specify which OpenID Provider to log in with by using the Login?OpenIDProvider=idofOpenIDProvider URL parameter.

Alternate Token Fields

Email addresses can be acquired from different fields in the OpenID Token. Two options available in all versions are id_token and access_token. Starting in v9.5, users also have the option of the UserInfo field. Alternate token fields can be accessed when setting up or editing an Identify Provider, and then enabling the box "Get email address from alternate token field". The list of possible fields will appear.

Email Scope

In v9.4 and above users have a property for the IdP settings that allows email scope to be omitted. In certain use cases where IdP is blocking the sending of email because of the email scope, this option can be used to allow email to be sent.

Generally it is recommended to ignore unrecognized scopes.

Feature Changes