AWS Cognito Single Sign-On (SSO) WordPress OAuth & OpenID | AWS Cognito SSO

AWS Cognito Single Sign-On (SSO) WordPress OAuth & OpenID | AWS Cognito SSO


Configure AWS Cognito Single Sign-On (SSO) with WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin. Enable secure login into WordPress using AWS Cognito as OAuth and OpenID Connect provider. AWS Cognito Single Sign-On (SSO) with WordPress allows your users to login to your WordPress and access the site by authenticating with their AWS Cognito identity provider. You can also configure plugin using different IDPs such as Azure AD, Office 365, and other custom providers. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, multi-tenant login etc. Here we will go through a guide to configure AWS Cognito Single Sign-On (SSO) with WordPress for user authentication. By the end of this guide, users should be able to perform secure login to WordPress and access the site with AWS Cognito SSO. 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 (SSO) plugin and click on Install Now.
  • Once installed click on Activate.



Steps to configure AWS Cognito Single Sign-On (SSO) Login into WordPress

1. Setup Amazon Cognito as OAuth Provider

  • First of all, go to Amazon Console and sign up/login in your account to Configure AWS Cognito.
  • AWS Cognito Single Sign-On (SSO) - Login to Amazon Console
  • Search for Cognito in the AWS Services search bar as shown below.
  • AWS Cognito Single Sign-On (SSO) - Search for AWS Cognito
  • Click on Mange User Pools button to see the list of your user pools.
  • AWS Cognito Single Sign-On (SSO) - AWS Cognito User Pools
  • Click on Create a user pool to create a new user pool.
  • AWS Cognito Single Sign-On (SSO) - Create New AWS Cognito Pool
  • Add a Pool Name and click on the Review Defaults button to continue.
  • AWS Cognito Single Sign-On (SSO) - Name your AWS Cognito User Pool
  • Scroll down and click on the Add App Client option in front of App Clients.
  • AWS Cognito Single Sign-On (SSO) - AWS Cognito App Client
  • Click on Add an App Client. Enter an App Client Name and click on Create app client to create an App client.
  • AWS Cognito Single Sign-On (SSO) - Create App Client
  • Click on Return to Pool Details to come back to your configuration.
  • AWS Cognito Single Sign-On (SSO) - AWS Cognito Pool
  • Click on Create Pool button to save your settings and create a user pool.
  • AWS Cognito Single Sign-On (SSO) - Save AWS Cognito Pool
  • In the navigation bar present on the left side, click on the App Client Settings option under the App Integration menu.
  • AWS Cognito Single Sign-On (SSO) - AWS Cognito App Details
  • Enable Identity provider as Cognito user pool and enter your Callback/Redirect URL which you will get from your miniOrange plugin present on your Client side under the CallBack URLs text-field. Select Authorization code grant checkbox under the Allowed OAuth Flows and also select openid and profile checkboxes under the Allowed OAuth Scopes option (Please refer to the image below). Click on the Save Changes button to save your configurations.
  • AWS Cognito Single Sign-On (SSO) - AWS Cognito App Client
  • Click on Choose Domain Name option to set a domain name for your app.
  • AWS Cognito Single Sign-On (SSO) - AWS Cognito Domain Names
  • Click on Domain name section. Enter your Domain Name under the Domain Prefix text-field and click on the Save Changes button to save your domain name.
  • Copy the the domain name as shown in the below image as we will require it later while configuring the OAuth plugin.
  • AWS Cognito Single Sign-On (SSO) - AWS Cognito Domain Name
  • Click on App Clients option under the General Settings menu in the left side navigation bar. Then, click on the Show Details button to see your App details like Client ID, Client secret etc.
  • AWS Cognito Single Sign-On (SSO) - Client Details
  • Copy the Client App ID and Client App Secret text field values and save them under your miniOrange plugin present on the client side under the Client Id and the Client Secret text fields respectively.
  • AWS Cognito Single Sign-On (SSO) - Client Configuration
  • Click on Users and groups option under the General Settings menu in the left side navigation bar. Then, click on the Create user button to add a new user.
  • AWS Cognito Single Sign-On (SSO) - App New User Creation
  • Fill all the required details and click on Create user.
  • AWS Cognito Single Sign-On (SSO) - Client Configuration
  • You can see the new user created.
  • AWS Cognito Single Sign-On (SSO) - App Client Configuration

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


2. Setup WordPress as OAuth Client

  • After Plugin is activated, go to the plugin and search for AWS Cognito. Select AWS Cognito from the OAuth Providers list.
  • AWS Cognito Single Sign-On (SSO) - Amazon Cognito as OAuth Provider
  • To configure AWS Single Sign-On (SSO), go to Configure OAuth tab and configure App Name, Client ID, Client Secret from provided Endpoints.
  • openid is already filled but if it doesn't work then configure scope as User.Read and for fetching group info use scope is Directory.read.all.
  • Please refer the below table for configuring the scope & endpoints for Amazon Cognito in the plugin.

    Client ID : Click Here
    Client Secret : Click Here
    Scope: openid
    Authorize Endpoint: https://<cognito-app-domain>/oauth2/authorize
    Access Token Endpoint: https://<cognito-app-domain>/oauth2/token
    Get User Info Endpoint: https://<cognito-app-domain>/oauth2/userInfo
    Custom redirect URL after logout:[optional] https://<cognito-app-domain>/logout?client_id=<Client-ID>&logout_uri=<Sign out URL configured in Cognito Portal>
  • Click on Save Settings to save the configuration.
  • AWS Cognito Single Sign-On (SSO) - Cognito SSO save settings

You have successfully configured WordPress as OAuth Client for achieving AWS Cognito Single Sign-On (SSO) with WordPress for user authentication.


3. User Attribute Mapping

  • User Attribute Mapping is mandatory for enabling users to successfully Single Sign-On into WordPress using AWS SSO. We will be setting up user profile attributes for WordPress using the below settings.
  • Finding user attributes

    • Go to Configure OAuth tab. Scroll down and click on Test Configuration.
    • AWS Cognito Single Sign-On (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.
    • AWS Cognito Single Sign-On (SSO) - test congifuration result
    • Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, select attributes from Username dropdown and click on Save.
    • AWS Cognito Single Sign-On (SSO) - 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.
    • AWS Cognito 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

    • AWS Cognito 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.
    • AWS Cognito 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 Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a AWS SSO login widget on your WordPress page, you need to follow the below steps.
    • 1. 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.
      • AWS Cognito Single Sign-On (SSO) - create-newclient login button setting

      2. 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.
      • AWS Cognito Single Sign-On (SSO) - create-newclient login button setting
      • Open your WordPress page and you can see the AWS SSO login button there. You can test the AWS Single Sign-On (SSO) now.

      In this Guide, you have successfully configured AWS Cognito Single Sign-On (SSO) by configuring AWS Cognito as OAuth Provider and WordPress as OAuth Client using our WP OAuth Single Sign-On ( OAuth / OpenID Connect Client ) plugin.This solution ensures that you are ready to roll out secure access to your WordPress site using AWS Cognito login credentials within minutes.


      Additional Resources


      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