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

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



WordPress OAuth / OpenID connect Single Sign-On plugin enables login into your WordPress site using any custome OAuth or OpenID Connect providers and standard providers. It supports advanced SSO features like user profile attribute mapping, role mapping etc. To know more about other features we provide in WP OAuth Single Sign-On ( OAuth / OpenID Connect Client ) plugin, you can click here

Pre-requisites: Download And Installation

  • Log into your WordPress instance as an admin.
  • Go to the WordPress Dashboard -> Plugins and click on Add New.
  • Search for a WordPress OAuth Single Sign On plugin and click on Install Now.
  • Once installed click on Activate.

1. Setup OAuth 2.0 compliant Provider

  • Register an OAuth application on your Provider by configuring the Callback URL provided in the plugin.
  • Collect the endpoints given below from your Provider to configure them in the plugin.

2. Setup WordPress as OAuth Client

  • Go to the Configure OAuth tab in the Plugin and search for Custom OAuth in the applications list, and select Custom OAuth 2.0 App .
  • wordpress oauth client plugin sso : save settings
  • Now, configure App Name, Client ID, Client Secret received from OAuth Provider.
  • Please refer the below table for configuring the scope & endpoints in the plugin.

    EndpointsUse
    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.
    User Info Endpoint Access the user profile information.
  • Click on Save Settings to save the configuration.

  •  WordPress custom oauth app sso save settings

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.
    • WordPress custom oauth app sso : test congifuration
    • 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.
    • WordPress custom oauth app sso test congifuration result
    • 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.
    • WordPress custom oauth app sso WordPress attribute/role mapping

    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.
    • Okta Single Sign-On (SSO) - attribute mapping
    • 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

    • Okta Single Sign-On (SSO) - test configuration - role mapping
    • 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.
    • Okta Single Sign-On (SSO) - test configuration - role mapping
    • 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. Login Settings / Sign In Settings.

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

      • Go to WordPress Left Panel > Appearances > Widgets.
      • Select miniOrange OAuth. Drag and drop to your favourite location and save.
      • WordPress custom oauth app sso login button setting
      • Open your WordPress page and you can see the login button there. You can test the SSO now.

      Additional Resources

      Need Help?

      Mail us on oauthsupport@xecurify.com for quick guidance(via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com