Difference between revisions of "Schoolbox"

From Studentnet Wiki
Jump to navigation Jump to search
 
(7 intermediate revisions by 3 users not shown)
Line 6: Line 6:
  
 
- Ensure Schoolbox is available both internally and externally on the exact same URL
 
- Ensure Schoolbox is available both internally and externally on the exact same URL
 
- Configure the SAML Identity Provider information as below.
 
  
  
Line 14: Line 12:
 
# Log in to your Schoolbox account as a Superuser
 
# Log in to your Schoolbox account as a Superuser
 
# Go to '''Administration''' --> '''Settings''' --> '''SAML''' (May appear as '''Security''' instead)
 
# Go to '''Administration''' --> '''Settings''' --> '''SAML''' (May appear as '''Security''' instead)
# Set the Single Sign-On URL for your identity provider e.g. https://''School URL''/adfs/ls [[File:SchoolboxSSO.png]]
+
# Set the "Single Sign-On URL" field to the URL found in your '''Cloudwork Dashboard'''>'''Single Sign On'''>'''Identity Provider'''>'''Metadata Details'''>'''Sign On Endpoint'''<br>[[File:Sign_On_Endpoint.png|300px|centre|frame|Example of Sign On Endpoint]]
# (First option) Set the "Single Sign-On Identity Provider Metadata URL": This allows Schoolbox to automatically determine the Token Signing Certificates and capabilities of your Identity Provider. e.g. https://''School URL''/FederationMetadata/2007-06/FederationMetadata.xml [[File:Ssoidpschoolbox.png]]
+
# (First option) Set the "Single Sign-On Identity Provider Metadata URL" field to the URL found in your '''Cloudwork Dashboard'''>'''Single Sign On'''>'''Identity Provider'''>'''XML File'''>'''Download'''(Right click > Copy Link Address)<br>[[File:Xml_download.PNG|300px|centre|frame|Location of XML File Download]]
# (Second Option) (Option 2) Copy the manually exported contents of the PEM format token signing certificate shown in the earlier earlier steps from "Single Sign-On IDP certificate" e.g. [[File:Idpcertschoolbox.png]]
+
# (Second Option) Set the "Single SIgn-On IDP certificate" field to the PEM format contents of your token signing certificate. You can get this by downloading the .crt file from your Cloudwork Dashboard > Single Sign On > Identity Provider > Certificate > Download then opening that .crt file in notepad and copying the contents across. e.g. [[File:Idpcertschoolbox.png]]
 +
# Set the Single Sign-On Logout URL to {SCHOOLBOX_ADDRESS} [[File:Logoutaddress.png]]
 
# Enable Single Logout
 
# Enable Single Logout
# Set Single Logout Endpoint to https://schoolname.instructure.com
+
# Set "Single Logout URL Endpoint" field to the URL found in your '''Cloudwork Dashboard''' > '''Single Sign On''' > '''Identity Provider''' > '''Metadata Details''' > '''Log Out Endpoint''' [[File:Seturl.png]]
 
# Press 'Save' to save the set up
 
# Press 'Save' to save the set up
  
  
 
[[Category:Single Sign On Services]]
 
[[Category:Single Sign On Services]]

Latest revision as of 05:44, 14 October 2021

Set up

Important steps

- Ensure Schoolbox is configured with HTTPS/SSL

- Ensure Schoolbox is available both internally and externally on the exact same URL


Set up steps

  1. Log in to your Schoolbox account as a Superuser
  2. Go to Administration --> Settings --> SAML (May appear as Security instead)
  3. Set the "Single Sign-On URL" field to the URL found in your Cloudwork Dashboard>Single Sign On>Identity Provider>Metadata Details>Sign On Endpoint
    Example of Sign On Endpoint
  4. (First option) Set the "Single Sign-On Identity Provider Metadata URL" field to the URL found in your Cloudwork Dashboard>Single Sign On>Identity Provider>XML File>Download(Right click > Copy Link Address)
    Location of XML File Download
  5. (Second Option) Set the "Single SIgn-On IDP certificate" field to the PEM format contents of your token signing certificate. You can get this by downloading the .crt file from your Cloudwork Dashboard > Single Sign On > Identity Provider > Certificate > Download then opening that .crt file in notepad and copying the contents across. e.g. Idpcertschoolbox.png
  6. Set the Single Sign-On Logout URL to {SCHOOLBOX_ADDRESS} Logoutaddress.png
  7. Enable Single Logout
  8. Set "Single Logout URL Endpoint" field to the URL found in your Cloudwork Dashboard > Single Sign On > Identity Provider > Metadata Details > Log Out Endpoint Seturl.png
  9. Press 'Save' to save the set up