Contents

Canvas OAuth & OpenID Connect Single Sign-On (SSO) in Magento | Canvas SSO Login | Magento SSO

Integration of Canvas Login with Magento using OAuth 2.0 Protocol. The Magento OAuth / OpenID Connect Single Sign-On (SSO) plugin makes it easy to use OAuth2 to set up Canvas Login on Magento (Canvas Single Sign on).

The plugin can be set up using other Social Media sources, as well as custom OAuth and OIDC providers. It contains a lot of Single Sign-On (SSO) features, like Attribute Mapping for user profiles, Role Mapping, and so on. In this guide, we'll go over how to set up SSO between Magento and Canvas. At the end of this article, users should be able to log into Magento using Canvas. Click here to read more about the Magento OAuth Single Sign-On (OAuth & OpenID Connect Client) plugin's extra features.

The Magento OAuth & OpenID Connect Single Sign-On (SSO) plugin makes it possible to log into Magento securely using Canvas as an OAuth and OpenID Connect provider. You can also use alternative Oauth providers, such as Azure B2C, Office 365, and other custom providers, to configure the plugin. Advanced Single Sign-On features such as user profile Attribute Mapping, Role Mapping, and so on are supported. We'll go over how to set up SSO between Magento and Canvas in this article. Users should be able to log in to Magento through Canvas by the end of this guide.

Click here to know more about other features we provide in Magento OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin

Pre-requisites : Download And Installation

Installation using Composer:

Purchase the miniOrange OAuth / OpenID Connect Single Sign On extension from magento marketplace.
Go to My profile -> My Purchases
Please ensure you are using correct access keys (My Profile - Access Keys)
Paste the access keys in your auth.json file inside your project
Use the below command to add the extension to your project.
```
"composer require miniorange_inc/miniorange-oauth-sso"
```
You can see the module name and list of versions in the selector below the extension module name.
Run the following commands on command prompt to enable the extension.

php bin/magento setup:di:compile

php bin/magento setup:upgrade

Manual Installation:

Download the miniOrange OAuth OpenID Connect Single Sign-On extension zip from here.
Unzip all contents of the zip inside the MiniOrange/OAuth directory.

{Root Directory of Magento} app code MiniOrange OAuth

Run the following commands on command prompt to enable the extension.

php bin/magento setup:di:compile

php bin/magento setup:upgrade

OAuth / OpenID Connect Single Sign On – SSO (OAuth Client)

By miniOrange

(1)

Magento OAuth OpenID Connect SSO extension allows login (Single Sign-On) into Magento with your Azure AD, Azure B2C, AWS Cognito, WSO2, Okta, LinkedIn, Google, Facebook, Slack, Discord or other custom OAuth 2.0 providers [24/7 SUPPORT]

Get this plugin

Steps to configure Canvas OAuth & OpenID Single Sign-On (SSO) Login into Magento

1. Setup Canvas as OAuth Provider

Follow the steps below to configure Canvas as OAuth Provider

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

Magento Canvas SSO developer keys Magento 2 OAuth

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 configured Canvas as OAuth Provider for achieving Canvas Single Sign-On (SSO) with Magento for user authentication.

2. Configuring Magento 2 as OAuth Client

After successfully configuring OAuth Provider, go to OAuth Provider tab and configure OAuth Provider Name, Client ID, Client Secret, Scope and provided endpoints. (You can copy these values in STEP 2 from the application dashboard.)

Please refer below Endpoints to configure the OAuth client

Scope:	openid
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

Click on the Save button to save the settings.
Click on the Test Configuration button.

Magento 2 OAuth credentials Canvas SSO OAuth

You will see all the values returned by your OAuth Provider to Magento 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.
The miniOrange Premium Plugin also provides you the the feature to auto redirect your user to the IdP Login Page.

Magento 2 OAuth auto redirect to idp Magento SSO

Go to the Sign In Settings tab and check options to enable SSO on your Magento site.

You have successfully configured your Magento 2 as an OAuth Client. You will see the SSO button on your frontend. Click on the button and test the SSO.

Canvas magento SSO magento 2 OAuth client SSO Canvas SSO

3: Attribute Mapping (Optional). *This is Premium feature.

You can map attributes in the Attribute Mapping tab. Only username and email are allowed to be mapped in free version of the plugin. However, in the premium version of the plugin, you can map various attributes coming from your OAuth Provider to the attributes present in your Magento site.

Magento 2 OAuth attribute mapping Magento SSO

4: Role Mapping (Optional). *This is Premium feature.

You can specify a default role in the free plugin that will be allocated to all non-admin users when they conduct SSO.
Go to Attribute/Role mapping tab and navigate to Role Mapping section.
Select the Default Role and click on the Save button.

Canvas Magento SSO - Canvas Single Sign-On(SSO) Login in Magento - role mapping

By configuring Canvas as an OAuth Provider and Magento as an OAuth Client using our Magento OAuth Client plugin, you have successfully installed Magento Canvas Single Sign-On (SSO). Within minutes, you'll be able to provide safe access to your Magento site utilising Canvas login credentials thanks to this solution.

Additional Resources

If you are looking for anything which you cannot find, please drop us an email on magentosupport@xecurify.com