Tutorial: Azure Active Directory integration with Canvas
In this tutorial, you learn how to integrate Canvas with Azure Active Directory (Azure AD). Integrating Canvas with Azure AD provides you with the following benefits:
- You can control in Azure AD who has access to Canvas.
- You can enable your users to be automatically signed-in to Canvas (Single Sign-On) with their Azure AD accounts.
- You can manage your accounts in one central location - the Azure portal.
If you want to know more details about SaaS app integration with Azure AD, see What is application access and single sign-on with Azure Active Directory. If you don't have an Azure subscription, create a free account before you begin.
To configure Azure AD integration with Canvas, you need the following items:
- An Azure AD subscription. If you don't have an Azure AD environment, you can get one-month trial here
- Canvas single sign-on enabled subscription
In this tutorial, you configure and test Azure AD single sign-on in a test environment.
- Canvas supports SP initiated SSO
Adding Canvas from the gallery
To configure the integration of Canvas into Azure AD, you need to add Canvas from the gallery to your list of managed SaaS apps.
To add Canvas from the gallery, perform the following steps:
In the Azure portal, on the left navigation panel, click Azure Active Directory icon.
Navigate to Enterprise Applications and then select the All Applications option.
To add new application, click New application button on the top of dialog.
In the search box, type Canvas, select Canvas from result panel then click Add button to add the application.
Configure and test Azure AD single sign-on
In this section, you configure and test Azure AD single sign-on with Canvas based on a test user called Britta Simon. For single sign-on to work, a link relationship between an Azure AD user and the related user in Canvas needs to be established.
To configure and test Azure AD single sign-on with Canvas, you need to complete the following building blocks:
- Configure Azure AD Single Sign-On - to enable your users to use this feature.
- Configure Canvas Single Sign-On - to configure the Single Sign-On settings on application side.
- Create an Azure AD test user - to test Azure AD single sign-on with Britta Simon.
- Assign the Azure AD test user - to enable Britta Simon to use Azure AD single sign-on.
- Create Canvas test user - to have a counterpart of Britta Simon in Canvas that is linked to the Azure AD representation of user.
- Test single sign-on - to verify whether the configuration works.
Configure Azure AD single sign-on
In this section, you enable Azure AD single sign-on in the Azure portal.
To configure Azure AD single sign-on with Canvas, perform the following steps:
In the Azure portal, on the Canvas application integration page, select Single sign-on.
On the Select a Single sign-on method dialog, select SAML/WS-Fed mode to enable single sign-on.
On the Set up Single Sign-On with SAML page, click Edit icon to open Basic SAML Configuration dialog.
On the Basic SAML Configuration section, perform the following steps:
a. In the Sign on URL text box, type a URL using the following pattern:
b. In the Identifier (Entity ID) text box, type a URL using the following pattern:
These values are not real. Update these values with the actual Sign on URL and Identifier. Contact Canvas Client support team to get these values. You can also refer to the patterns shown in the Basic SAML Configuration section in the Azure portal.
In the SAML Signing Certificate section, click Edit button to open SAML Signing Certificate dialog.
In the SAML Signing Certificate section, copy the THUMBPRINT and save it on your computer.
On the Set up Canvas section, copy the appropriate URL(s) as per your requirement.
a. Login URL
b. Azure Ad Identifier
c. Logout URL
Configure Canvas Single Sign-On
In a different web browser window, log in to your Canvas company site as an administrator.
Go to Courses > Managed Accounts > Microsoft.
In the navigation pane on the left, select Authentication, and then click Add New SAML Config.
On the Current Integration page, perform the following steps:
a. In IdP Entity ID textbox, paste the value of Azure Ad Identifier which you have copied from Azure portal.
b. In Log On URL textbox, paste the value of Login URL which you have copied from Azure portal .
c. In Log Out URL textbox, paste the value of Logout URL which you have copied from Azure portal.
d. In Change Password Link textbox, paste the value of Change Password URL which you have copied from Azure portal.
e. In Certificate Fingerprint textbox, paste the Thumbprint value of certificate which you have copied from Azure portal.
f. From the Login Attribute list, select NameID.
g. From the Identifier Format list, select emailAddress.
h. Click Save Authentication Settings.
Create an Azure AD test user
The objective of this section is to create a test user in the Azure portal called Britta Simon.
In the Azure portal, in the left pane, select Azure Active Directory, select Users, and then select All users.
Select New user at the top of the screen.
In the User properties, perform the following steps.
a. In the Name field enter BrittaSimon.
b. In the User name field type email@example.com
For example, BrittaSimon@contoso.com
c. Select Show password check box, and then write down the value that's displayed in the Password box.
d. Click Create.
Assign the Azure AD test user
In this section, you enable Britta Simon to use Azure single sign-on by granting access to Canvas.
In the Azure portal, select Enterprise Applications, select All applications, then select Canvas.
In the applications list, select Canvas.
In the menu on the left, select Users and groups.
Click the Add user button, then select Users and groups in the Add Assignment dialog.
In the Users and groups dialog select Britta Simon in the Users list, then click the Select button at the bottom of the screen.
If you are expecting any role value in the SAML assertion then in the Select Role dialog select the appropriate role for the user from the list, then click the Select button at the bottom of the screen.
In the Add Assignment dialog click the Assign button.
Create Canvas test user
To enable Azure AD users to log in to Canvas, they must be provisioned into Canvas. In the case of Canvas, user provisioning is a manual task.
To provision a user account, perform the following steps:
Log in to your Canvas tenant.
Go to Courses > Managed Accounts > Microsoft.
Click Add New User.
On the Add a New User dialog page, perform the following steps:
a. In the Full Name textbox, enter the name of user like BrittaSimon.
b. In the Email textbox, enter the email of user like firstname.lastname@example.org.
c. In the Login textbox, enter the user’s Azure AD email address like email@example.com.
d. Select Email the user about this account creation.
e. Click Add User.
You can use any other Canvas user account creation tools or APIs provided by Canvas to provision AAD user accounts.
Test single sign-on
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
When you click the Canvas tile in the Access Panel, you should be automatically signed in to the Canvas for which you set up SSO. For more information about the Access Panel, see Introduction to the Access Panel.
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.