Auth0 Single Sign-On (SSO) | WordPress Login using Auth0
Auth0 Single Sign-On (SSO) | WordPress Login using Auth0
WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin enables secure login into WordPress using Auth0 as OAuth and OpenID Connect provider. You can also configure plugin using different custom providers and standard IDPs. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, etc. Here we will go through a guide to configure SSO between WordPress and Auth0. By the end of this guide, users should be able to login to WordPress from Auth0. 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 Auth0 Single Sign-On (SSO) - Auth0 OAuth Login into WordPress
1. Setup Auth0 as OAuth Provider
- Go to https://auth0.com/auth/login and sign up or login.
- Go to Applications tab in the left panel and then click on Applications.
- click on Create application to create a new application.
- Select Regular web Applications and click on Create button.
- Now go to settings tab.
- Scroll down to Applications URI's section and enter the callback url which you will get from plugin. Then, Scroll down and Click on save changes.
- Copy the Client ID and Client Secret from basic information in setttings tab and save it on your miniOrange OAuth Client plugin Configuration..
- Now go to Users tab in the user management from the left panel.
- Click on Create User to create a new user.
- Enter all the required details and click on Create.
You have successfully configured Auth0 as OAuth Provider for achieving Auth0 SSO login into your WordPress Site.
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 Auth0
- After selecting the provider copy the Callback URL which needs to be configured in OAuth Provider's SSO application Configuration.
- Enter the Client Credentials like Client ID & Client Secret which you will get from the Auth0 SSO application.
- Configure Domain Name found from the Auth0 SSO application. Please refer the below table for configuring the scope & endpoints for Auth0 in the plugin.
- Click on Next.
- After verifying all the details on the summary page, click on Finish to save the configuration as well as test the SSO connection.
Note: Once you create the Auth0 account, you'll find the domain Url and you will need to add the same in the below endpoints.
| Scope: | openid profile email |
| Authorize Endpoint: | https://<Auth0-app-domain>/authorize |
| Access Token Endpoint: | https://<Auth0-app-domain>/oauth/token |
| Get User Info Endpoint: | https://<Auth0-app-domain>/userinfo |
You have successfully configured WordPress as OAuth Client for achieving Auth0 login into your WordPress Site.
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.
- 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.
Finding user attributes
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. Create custom attributes in Auth0
- Go to https://auth0.com/auth/login to login into your Auth developer account.
- In the left panel, go to Action -> Flows -> Login.
- Click on Add Action -> Build Custom.
- Enter your desired name and keep the other settings as they are. Click on Create button.
- Write the below code in the code editor. After writing the code, click on Deploy.
Code:
exports.onExecutePostLogin = async (event, api) => {
const attr_name = "favorite_color";
api.idToken.setCustomClaim( attr_name , 'Purple');
// ... additional code
};
Code Description:
attr_name: This will be the attribute name which will you want to create (favorite_color in my case)
The function api.idToken.setCustomClaim(), expects the key and its value. Here, the key is attr_name, and its value is “Purple”
6. Sign In Settings
- The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Auth0 login widget on your WordPress page, you need to follow the below steps.
- Go to WordPress Left Panel > Appearances > Widgets.
- Select miniOrange OAuth. Drag and drop to your favourite location and save.
- 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 Auth0 SSO login button there. You can test the Auth0 Single Sign-On (SSO) - Auth0 OAuth now.
- 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 an Auth0 SSO login button there. Once you click the login button, you will be able to test the Auth0 Single Sign-On (SSO) - Auth0 OAuth.
- OAuth 2.0 Authorization Framework
- What is OAuth 2.0?
- WordPress Single Sign-On (SSO) OAuth / OpenID Connect / JWT
- What is OAuth 2.0 and how does it work?
- How we are different
With OAuth & OpenID Connect Single Sign-On (SSO) plugin you have achieved WordPress Auth0 Authentication and successfully enabled Auth0 SSO Login by configuring Auth0 as OAuth Provider and WordPress as OAuth Client. Auth0 OAuth Authorization means you're ready to roll out secure access to your WordPress(WP) site in minutes, allowing users to safely authenticate using Auth0 SSO credentials.
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.
Need Help? We are right here!
