Difference between revisions of "Canvas"

From Studentnet Wiki
Jump to navigation Jump to search
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
Canvas is a Learning Management System
 
Canvas is a Learning Management System
  
To add a Canvas service you need to upload the XML file to the Cloudwork dashboard
+
To add Single Sign On for a Canvas service you need to upload the XML file to the Cloudwork dashboard
  
 
+
== Getting the XML file: ==
'''To get the XML file:'''
 
  
 
Metadata is at https://<<schoolcode>>.instructure.com/saml_meta_data and the certificate needs to be entered in as a fingerprint
 
Metadata is at https://<<schoolcode>>.instructure.com/saml_meta_data and the certificate needs to be entered in as a fingerprint
Line 10: Line 9:
 
Then some work needs to be done in Canvas before uploading the XML file to the dashboard.
 
Then some work needs to be done in Canvas before uploading the XML file to the dashboard.
  
Go to Admin -> Authentication
+
In Canvas, Go to '''Admin''' -> '''Authentication'''
 
On the dropdown on the right choose SAML. The settings are shown below
 
On the dropdown on the right choose SAML. The settings are shown below
  
 
[[File:propercanvas2.png|700px]]
 
[[File:propercanvas2.png|700px]]
  
''The definitions for both Entity ID and Sign On and Sign Out Endpoint can be found in [http://wiki.studentnet.net/index.php?title=Features#Identity_Provider_Details Identity Provider Details]''
+
*IdP Metadata URL - The Entity ID of the metadata, this is found in the Cloudwork Dashboard, Go to '''Single Sign on'''>'''Identity Provider'''>'''Metadata Details'''>'''Entity ID'''. <br>
*IdP Metadata URL - The Entity ID of the metadata, this is found in the Cloudwork Dashboard, Go to Features -> Single Sign on -> Identity Provider.  
+
*IdP Entity ID - Also the Entity ID of the metadata, this is found in the Cloudwork Dashboard, Go to '''Single Sign on'''>'''Identity Provider'''>'''Metadata Details'''>'''Entity ID'''. <br>
*IdP Entity ID - Also the Entity ID, see above
+
*Log On URL - This is the Sign On Endpoint, this is also found in the Cloudwork Dashboard, Go to '''Single Sign On'''>'''Identity Provider'''>'''Metadata Details'''>'''Sign On Endpoint'''.<br>
*Log On URL - This is the Sign On Endpoint, this is also found in the Cloudwork Dashboard, Go to Features -> Single Sign on -> Identity Provider.
+
*Log Out URL - This is the Sign Out Endpoint which is also found in the Cloudwork Dashboard, Go to '''Single Sign On'''>'''Identity Provider'''>'''Metadata Details'''>'''Log Out Endpoint'''.<br>
*Log Out URL - This is the Sign Out Endpoint which is also found in the Cloudwork Dashboard, Go to Features -> Single Sign on -> Identity Provider.
+
*Certificate Fingerprint - The certificate can be downloaded from the Identity Provider details in the Cloudwork Dashboard.<br>
*Certificate Fingerprint - The certificate can be downloaded from the Identity Provider details in the Cloudwork Dashboard.
+
*Login Attribute - This should be: NameID<br>
*Login Attribute - This should be: NameID
+
*Identifier format - This should be: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress<br>
*Identifier format - This should be: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
 
  
 +
[[File:Idp_info.PNG|300px|centre|frame|Example of Identity Provider]]<br>
  
'''Uploading the XML file'''
 
  
Once you have the XML file go to the Cloudwork Dashboard -> Features -> Single Sign -> Add New Service -> Upload an XML file.
+
== Uploading the XML file ==
 +
 
 +
Once you have the XML file go to the Cloudwork Dashboard and then go to '''Single Sign On'''>'''Add New Service'''>'''Upload an XML file'''.
  
 
This will lead to a page that looks like this:
 
This will lead to a page that looks like this:
Line 36: Line 36:
 
*Upload - Here is where you upload the XML file for Canvas
 
*Upload - Here is where you upload the XML file for Canvas
  
 +
== Testing ==
  
'''Testing'''
+
Then you can test the login before by going to https://<<schoolcode>>.instructure.com/login/saml
 +
 
 +
Once you are ready to go just change the position to 1 and it will become the default authentication. This part is done in Canvas.
  
Then you can test the login before by going to https://<<schoolcode>>.instructure.com/login/saml
 
  
Once you are ready to go just change the position to 1 and it will become the default authentication. This is done in Canvas.
+
[[Category:Single Sign On Services]]

Latest revision as of 00:45, 15 June 2022

Canvas is a Learning Management System

To add Single Sign On for a Canvas service you need to upload the XML file to the Cloudwork dashboard

Getting the XML file:

Metadata is at https://<<schoolcode>>.instructure.com/saml_meta_data and the certificate needs to be entered in as a fingerprint

Then some work needs to be done in Canvas before uploading the XML file to the dashboard.

In Canvas, Go to Admin -> Authentication On the dropdown on the right choose SAML. The settings are shown below

Propercanvas2.png

  • IdP Metadata URL - The Entity ID of the metadata, this is found in the Cloudwork Dashboard, Go to Single Sign on>Identity Provider>Metadata Details>Entity ID.
  • IdP Entity ID - Also the Entity ID of the metadata, this is found in the Cloudwork Dashboard, Go to Single Sign on>Identity Provider>Metadata Details>Entity ID.
  • Log On URL - This is the Sign On Endpoint, this is also found in the Cloudwork Dashboard, Go to Single Sign On>Identity Provider>Metadata Details>Sign On Endpoint.
  • Log Out URL - This is the Sign Out Endpoint which is also found in the Cloudwork Dashboard, Go to Single Sign On>Identity Provider>Metadata Details>Log Out Endpoint.
  • Certificate Fingerprint - The certificate can be downloaded from the Identity Provider details in the Cloudwork Dashboard.
  • Login Attribute - This should be: NameID
  • Identifier format - This should be: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
Example of Identity Provider



Uploading the XML file

Once you have the XML file go to the Cloudwork Dashboard and then go to Single Sign On>Add New Service>Upload an XML file.

This will lead to a page that looks like this:

Xml.png

  • Name - A friendly name to identify the service e.g. Canvas
  • Upload - Here is where you upload the XML file for Canvas

Testing

Then you can test the login before by going to https://<<schoolcode>>.instructure.com/login/saml

Once you are ready to go just change the position to 1 and it will become the default authentication. This part is done in Canvas.