Install and Configure OpenID Connect (OIDC) Client for a Drupal 10 or Drupal 11 website

Environment

A university website based on Drupal 10 or Drupal 11

Issue

How to install and configure OpenID Connect (OIDC) client for Drupal 10 or Drupal 11 Content Management System.

 

Before You Begin

  • You will need to obtain OIDC credentials for your site
    • These can be self-provisioned using the OIDC Provisioning and Management (OPaM) tool at https://admin.webservices.umich.edu/
    • Provision OIDC service client credentials for your site per the instructions in the following ITS Knowledge Article: How to Provision OIDC Service Client Credentials

Resolution

  1. Install the openid_connect module using composer, as shown on the Releases page on the module site.  See the instructions in step #4 of the knowledge article "Install Drupal 9/10 CMS in an AFS-Based Virtual Host" to see how to install composer within your {{doc_root}} directory.
cd {{doc_root}}
vendor/bin/composer require 'drupal/openid_connect:^1.4'
  1. Navigate to "Manage → Extend → OpenID Connect", check the check box, and press the "Install" button

 

  1. After the module is installed, configure it by navigating to “Manage → Configuration → OpenID Connect” in the site administrator dashboard
    1. Configure the plugin using the following settings:

Setting Name

Setting Value
Enabled OpenID Connect clients     Generic
Generic:  Client ID ${OIDC_ID}
Generic:  Client secret     ${OIDC_SECRET}
Generic:  Authorization endpoint https://weblogin.umich.edu/idp/profile/oidc/authorize
Generic:  Token endpoint https://weblogin.umich.edu/idp/profile/oidc/token
Generic:  UserInfo endpoint https://weblogin.umich.edu/idp/profile/oidc/userinfo
Override registration settings unchecked
Save user claims on every login checked
OpenID buttons display in user login form {site admin preference}
Advanced:  Automatically connect existing users unchecked
  1. Save the updated settings using the 'Save configuration' button at the bottom of the configuration page

Additional Information

Need additional information or assistance? Contact the ITS Service Center.

Print Article