Contents

Joomla OAuth Client Integration with Canvas Single Sign-On (SSO)

Integration of Canvas Single Sign-on (Canvas SSO ) with Joomla using OAuth 2.0 Protocol. The miniOrange Joomla OAuth / OpenID Connect Single Sign-on (SSO) plugin makes it simple to set up Canvas SSO into Joomla and enable secure login into joomla. As a result, users can log in to Joomla and access the site by authenticating with their Canvas identity provider credentials.

Visit our Joomla OAuth Client Plugin page to learn more about the features and Pricing plans we offer for the Joomla OAuth Single Sign-on (OAuth & OpenID connect) plugin.

Joomla OAuth Client Handbook

Please refer our detailed Handbook for the Joomla OAuth/OpenID Single Sign-On plugin, which gives an in-depth explanation of the various features of the plugin. You can get to the handbook at anytime directly from the plugin's UI for quicker access.

Pre-requisites : Download And Installation

Download

Handbook

Free Trial

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.

Canvas OAuth SSO with Joomla | Canvas Single Sign-On, Canvas Admin

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

Login with Canvas into Joomla | Canvas SSO with Joomla, Canvas Developer

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.

Canvas OAuth OpenID Connect with Joomla | Single Sign-On with Joomla using Canvas, Form-Details

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

Canvas OAuth SSO with Joomla | Canvas Single Sign-On, Client-ID

Login with Canvas into Joomla | Canvas SSO with Joomla, Client Secret

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
Set Client Credentials:	In Both (In Header and In Body)

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

1.1 User Attribute Mapping

User Attribute Mapping is mandatory for enabling users to successfully login into Joomla. We will be setting up user profile attributes for Joomla using below settings.

Finding user attributes

Go to Configure OAuth tab. Scroll down and click on Test Configuration after filling in the details.

Canvas Single Sign-on (SSO) - OAuth Test Configuration

You will see all the values returned by your OAuth Provider to Joomla 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.

Canvas Single Sign-on (SSO) - Attribute Name

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. Now select Save Attribute Mapping.

Canvas Single Sign-on (SSO) - Joomla Attribute Mapping

Download the zip file for the miniOrange OAuth Client plugin for Joomla from the link here.

Joomla Oauth / OpenID Connect Single Sign-on SSO for Joomla - App Client Configuration

Login into your Joomla site’s administrator console.
From left toggle menu, click on System, then under Install section click on Extension.

Upload the downloaded zip file to install the Joomla OAuth Client plugin.

From left toggle menu click on Components, then click on miniOrange OAuth Client , then click on Configure OAuth tab.
Under Configure OAuth tab . Select your OAuth Provider. (If your OAuth Provider not listed then click on Custom OAuth/ Custom OpenID connect App .)

Fill in the details you received from your OAuth Provider.
Copy the Redirect/Callback URL given in the plugin and click on the Save Settings button to save details in your OAuth Provider. Then click on Test Configuration button.

After click on the Test Configuration button and copy the email and name attributes and save these attributes in Email Attribute and Name Attribute text field respectively. Now click on the Save Attribute Mapping button to save your configurations.

Use the Login URL to perform the SSO of your pre-configured OAuth/OpenID Connect Provider, (After completing test configuration please copy the Login URL and Add a button on your site login page).

Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.
Congratulations, you have successfully configured the miniOrange OAuth Client plugin with your desired OAuth Provider.
Click on the Upgrade Plans tab to check out our complete list of features and various licensing plans. OR you can click here to check features and licensing plans
If you want to purchase any of the paid version of the plugin, you have to register/login with us in Account Setup tab. OR you can register/login Here
In case, you are facing some issue or have any question in mind, you can reach out to us by sending us your query through the Support button in the plugin or by sending us a mail at joomlasupport@xecurify.com.

Download the zip file for the miniOrange OAuth Client plugin for Joomla from the link here.

Login into your Joomla site’s administrator console.
Go to Extension Manage Install in the top navigation bar to install the plugin.

Upload the downloaded zip file to install the OAuth Client plugin.

Navigate to Extensions Manage Manage and search for miniorange in the Search bar provided to see the list of the components.
Go to Components MiniOrange OAuth Client Configure OAuth tab from the top navigation bar to go to the configuration page of the plugin.

Select your OAuth Provider from the Select Application dropdown. In case your OAuth Provider is not listed in the drop down, please select Custom OAuth Provider to continue.

Fill in the details you received from your OAuth Provider.
Copy the Redirect/Callback URL given in the plugin and click on the Save Settings button to save details in your OAuth Provider.
Click on the Test Configuration button and copy the email and name attributes and save these attributes in Email Attribute and Name Attribute text field respectively. Now click on the Save Attribute Mapping button to save your configurations.

Use the Login URL to perform the SSO of your pre-configured OAuth/OpenID Connect Provider, (After completing test configuration please copy the Login URL and Add a button on your site login page).

Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.
Congratulations, you have successfully configured the miniOrange OAuth Client plugin with your desired OAuth Provider.
Click on the Upgrade Plans tab to check out our complete list of features and various licensing plans. OR you can click here to check features and licensing plans
If you want to purchase any of the paid version of the plugin, you have to register/login with us in Account Setup tab. OR you can register/login Here
In case, you are facing some issue or have any question in mind, you can reach out to us by sending us your query through the Support button in the plugin or by sending us a mail at joomlasupport@xecurify.com.

Recommended Add-Ons

Page and Post
Restriction

Page and Post Restriction plugin restricts Joomla pages and posts of the site based on User Roles and their Login Status.

Know More

Role/Group Based Redirection

Role/Group-Based Redirection Add-on can be used to redirect the user to a specific URL based on the roles/groups received from the OAuth server.

Know More

SSO Session
Management

SSO session management add-on manages the login session time of your users based on their Joomla roles.

Know More

Additional Resources

Mail us on joomlasupport@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.

Joomla OAuth Client Integration with Canvas Single Sign-On (SSO)

Contents

Joomla OAuth Client Integration with Canvas Single Sign-On (SSO)

Joomla OAuth Client Handbook

Pre-requisites : Download And Installation