Canvas OAuth & OpenID connect Single Sign-On (SSO) | Canvas SSO Login

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 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 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.

Canvas Application Endpoints :

Client ID :	Click Here
Client Secret :	Click Here
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>/login/v2.1/users/self

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

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.

• Client Credentials like Client ID & Client Secret is shown in the setup dialogue box, openid is already filled, enter profile and 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 Canvas SSO application.

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

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. Sign In Settings

• The settings in 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.

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