How do I add an SSO login link to School system emails?

If you are utilizing SSO for your School portal login, users can access course enrollments via your SSO app URL from the school email notifications.

First, copy your app embed link from your SSO app. For example, from your Azure, Google, Okta, etc. app tile, right click and select “Copy link address”.

You can paste this link in the "App embed link" field in your portal School Settings. 

Go to Administration> Settings > School Settings In school settings, SSO Tab

Add the URL address to the "App embed link" field and click Save.

Next, go to Administration> Manage System Emails.

Click Edit from "View" dropdown button on each email you want to update with the SSO link.

Note: The highlighted emails in the image below are the recommended system emails to update:

 

If the default system email includes the {school_reset_url} variable, you can remove it and replace it with text that will be hyperlinked with your SSO app embedded link, such as “Click here to login.” See example below.

 

Now, you will need to add to the email’s source code so that the app embed link variable creates the SSO hyperlink in that new text.

Click the Source button from the email body toolbar.

In the source code of the email, find the text you just added (ex: Click here to login). 

Tip: Using the Find shortcut (Ctrl + F or Command + F) on your keyboard can help locate where the text lives within the code.

Once you find that text line of code, you can replace it with the following school app embed link code:

<p><a href="{school_app_embed_link}">Click here</a> to login.</p>

Click Save.

When you are now back to your System Emails page, you can View a preview of the email and the text should now be hyperlinked to include your SSO app embed link. You can test the link from the email preview to confirm the link directs you to the correct login page.

 

You can repeat these steps to update each system email highlighted above.

Alternatively, if you do not wish to edit any source code or include a linked text in your emails and prefer the full SSO link to be pasted in the body, you can simply add the {school_app_embed_link} variable by itself.

So you would remove the {school_reset_url} (if applicable) and any other unwanted text from the email and paste this variable when editing:

{school_app_embed_link}

Click Save.

The full SSO app embed link will be displayed in your system emails and this will allow users to copy and paste the link into their browser to access your SSO login page.

Tip: A quick way to copy and paste the {school_app_embed_link} variable or any special fields variable in system emails is to copy from the Special Fields button on the Manage System Emails page.