Configure Canvas Single Sign-On (SSO) with OAuth for WordPress

Overview

Configure Canvas Single Sign-On (SSO) with the OAuth & OpenID Connect Single Sign-On plugin for WordPress. Enable secure login into WordPress using Canvas as an OAuth and OpenID Connect provider. Canvas Single Sign-On (SSO) with WordPress allows your users to log in to WordPress and access the site by authenticating with their Canvas identity provider. You can also configure the 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 Canvas 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 Canvas SSO. To know more about other features we provide in the OAuth Single Sign-On (OAuth & OpenID Connect Client) plugin for WordPress, you can click here.

Download Plugin Pricing Plans Free Trial

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 OAuth Single Sign On (SSO) Plugin for WordPress and click on Install Now.
• Once installed click on Activate.

Clever

ClassLink

Google Classroom

Office 365

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

1. Setup Canvas as OAuth Provider

• Login to your Canvas LMS domain as an Account Administrator.
• Go to the Admin tab and select the domain for which you wish to enable Single sign-on.

• Go to the Developer keys link and click on the Developer key button then select the API key option from the dropdown.

• Enter the required details such as Key Name, enter the Redirect URI from the miniOrange OAuth Client plugin under the OAuth Redirect URL field and click on Save button.

• Copy the Client ID and Client Secret and save it on your miniOrange OAuth Client plugin Configuration.

• You have successfully completed your Canvas App OAuth Server side configurations.

You have successfully configured Canvas as OAuth Provider for achieving Canvas login into your WordPress Site.

Step 2: Setup WordPress as OAuth Client

• Free
• Premium

• 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 Canvas

• Copy the Callback URL to be used in OAuth Provider Configuration. Click Next.

• Configure App name & endpoints found from the Canvas SSO application. Click Next.


Note: Once you create the Canvas account, you'll find the Site URL, and you will need to add the same in the below endpoints.




Authorize Endpoint:	https://<your-site-url>/login/oauth2/auth
Access Token Endpoint:	https://<your-site-url>/login/oauth2/token
Get User Info Endpoint:	https://<your-site-url>/login/v2.1/users/self

• Client Credentials like Client ID & Client Secret are shown in the setup dialogue box, openid, profile is already filled. Click Next.

• Click on Finish to save the configuration.

You have successfully configured WordPress as OAuth Client for achieving user authentication with Canvas Single Sign-On (SSO) login into your WordPress Site.

• Go to Configure OAuth tab and search your application name to add a new client application into your website, here Canvas.

• Configure App Name, Client ID, Client Secret and endpoints from the Canvas SSO application.


Note: Once you create the Canvas account, you'll find the Site URL, and you will need to add the same in the below endpoints.




Scope:	openid profile
Authorize Endpoint:	https://{your-site-url}/login/oauth2/auth
Access Token Endpoint:	https://{your-site-url}/login/oauth2/token
Get User Info Endpoint:	https://{your-site-url}/api/v1/users/self

• Choose your Grant Type from the list of options, hit Save and click on Test Configuration to test the setup.

You have successfully configured WordPress as OAuth Client for achieving user authentication with Canvas Single Sign-On (SSO) login into your WordPress Site.

Step 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 the dropdowns.

Step 4: Sign In Settings

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

• WordPress 5.7 and below
• WordPress 5.8
• WordPress 5.9 and above

• 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 Canvas SSO login button there. You can test the Canvas Single Sign-On (SSO) 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 a Canvas SSO login button there. Once you click the login button, you will be able to test the Canvas Single Sign-On (SSO).

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

Canvas SSO with Learndash Role Mapping

If you are using Learndash as your WordPress LMS and want to assign different Learndash courses to your (Classlink, Clever, Google Classroom) users based on their schools or different sections (such as k1, k2). You can use our Learndash Integration Add-on for WordPress, with the add-on instead of individually adding each person to a specific Learndash course, we may assign them directly to that course during SSO based on user groups and roles so that they can access that course straight from the WordPress site.

Related Articles

• What is OAuth 2.0?
• Canvas as OAuth Provider / OpenID Connect
• Single Sign-On (SSO) for WordPress
• What is OAuth 2.0 and how does it work?
• Frequently Asked Questions (FAQs)