Custom OAuth 2.0 Single Sign-On (SSO) | WordPress Login Using Custom OAuth Provider

1. Setup OAuth 2.0 compliant Provider

• Set up an OpenID Connect application on your Provider by configuring the Callback URL provided in the miniOrange OAuth Client Single Sign-On (SSO) plugin.

• You will need to collect the Scope and Endpoints provided from your provider to configure the OAuth Client Single Sign-On (SSO) plugin.
• You will get the Client ID and Client Secret from your OAuth provider, keep the Client ID and Client Secret handy as it will required later to configure WordPress OAuth Single Sign-On (SSO) Plugin.

You have successfully configured your OAuth Provider for achieving your OAuth provider Single Sign-On (SSO) with WordPress for user authentication.

2. Setup WordPress as OAuth Client

• Go to Configure OAuth tab and click Add New Application to add a new client application into your website.

• Choose your Application from the list of OAuth / OpenID Connect Providers, Here Custom OAuth 2.0 App.

• Copy the Callback URL to be used in your OAuth provider Configuration and Click on Next.


• Please refer the below table for configuring the scope & endpoints in the plugin.

  Endpoints	Use
  Client ID	Identify the application.
  Client Secret	Authenticate the Authorization Server.
  Scope	Limit an application's access to a user's account.
  Authorization Endpoint	Identify a user or obtain an authorization code.
  Access Token Endpoint	Allows an application to access an API.
  Get User Info Endpoint	Allows to get information about the user.


• Enter the Client Credentials like Client ID & Client Secret as shown in the setup dialogue box. Enter the scope value as openid. Click Next.

• Click on Finish to save the configuration.

3. User Attribute Mapping.

• User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.

Finding user attributes

• Go to Configure OAuth tab. Scroll down and click on Test Configuration. You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.

• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.

4. Role Mapping [Premium]

• Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
• From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.

• Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
  Eg: Role


• Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.
  
  For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.

• Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
  Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

5. Sign In Settings

• The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a your OAuth Provider login widget on your WordPress page, you need to follow the below steps.

Sign in settings for WordPress 5.7 and before

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.


Sign in settings for WordPress 5.8

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.

• Open your WordPress page and you can see the AWS Cognito SSO login button there. You can test the AWS Cognito Single Sign-On (SSO) now.

Sign in settings for WordPress 5.9

• Make sure the "Show on login page" option is enabled for your application. (Refer to the below image)

• Now, go to your WordPress Login page. (Eg. https://< your-wordpress-domain >/wp-login.php)
• You will see the SSO login button there. Once you click the login button, you will be able to test your OAuth Provider.