Integrating with Canvas

The following is an example using the configuration values that were filled in for CCSF's integration with Canvas. This document illustrates configuring your Canvas site to go straight to your college/district IdP. The updates below will route your college/district IdP through the CCC IdP Proxy instead. The following values will need to be updated in order to implement this change:

  • IdP entityID:  this will change to the Proxy IdP entityID
  • Log On URL: this will change to a URL that goes to the IdP Proxy SSO endpoint, and with a ?source= query argument identifying the college/district IdP to route to
  • Certificate fingerprint: this will become the certificate fingerprint of the IdP Proxy signing certificate
  • Note: the Logout URL, if you want the user logged out of your IdP after logging out of Canvas, will be same as below. The IdP Proxy will not keep a session, so you will need to configure Canvas to send the user to your IdP's Logout endpoint.


Each college using Canvas has one or two people who have been established as the "Canvas Administrators" for that college. The person(s) in that role has access to their Canvas site with "administrative privileges", including being able to configure how authentication is done for their Canvas site. This individual will need to make the changes outlined in this document. 

Canvas recommends that you first implement the changes on your Test/Beta site and ensure it is working correctly there prior to configuring it on your Production site. Please be aware that every few weeks, Instructure replaces your Test/Beta site config with your Production config, so you might have to repeat configuring the below multiple times if it takes longer to complete your verification testing.

This document tells you how to navigate to the page that has the SAML config options on it:

      https://community.canvaslms.com/docs/DOC-4284

Step 1- Click on "Authentication" in the left-hand pane of this screen: 

   


Then click on SAML in the right-hand side of the subsequent screen:


That will bring you to the main "SAML configuration form". The following information should be placed in the fields: 


* IdP entityID:  
    Note: this is the value of the 'idp.entityID=' property in the IdP's conf/idp.properties file and in your IdP's metadata.

* Log On URL:  
   Note: this is the Location value from the following entry in your IdP's metadata:
        <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://idp.ccsf.edu/idp/profile/SAML2/Redirect/SSO"/>  

* Log Out URL:  https://idp.ccsf.edu/idp/profile/Logout     (Example- please use your colleges version)
   Note: Only enter this if you want the user logged out of your IdP after logging out of Canvas.
        This is the Location value from the following entry in your IdP's metadata:
        <!-- Not actually a SAMLv2 Logout endpoint, but it is where we want SPs to send the user -->
        <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://idp.ccsf.edu/idp/profile/Logout"/>
* Pilot Certificate fingerprint: FB:97:39:4D:14:17:12:5A:F5:A3:DF:80:98:CB:74:F6:85:81:D5:A8

* Prod Certificate fingerprint: 02:B1:F7:19:22:4E:FE:1E:FF:46:E1:B5:BA:55:E8:14:10:5C:4D:59
  

* Login attribute: eduPersonPrincipalName

                 Or eduPersonPrincipalName (domain stripped) if you don't include the @campus.edu on the identifier you send to Canvas in the provisioning feed.


    There is a drop down with multiple choices, You want to choose one of the two 'eduPersonPrincipalName' choices. That has to match what you fill into the LOGIN_ID in the Canvas provisioning feed. Do NOT choose "NameID".

 
* Identifier Format:  urn:oasis:names:tc:SAML:2.0:nameid-format:transient

Choose the above value from the drop-down and Save your changes. The drop-down should have the following set of choices:



Testing

Testing should occur on the Test/Beta site that has been established for your college. An example of a test url is: https://ccsf.test.instructure.com/login/saml    You will need to replace the correct values associated to your college test site in order to successfully test the changes.