You must be signed in as a super administrator for this task.
With Security Assertion Markup Language (SAML), your users can sign in to enterprise cloud applications with their Google Cloud credentials.
Set up SSO via SAML for Canvas LMS
Before configuring SSO, ask Canvas LMS support to provide a unique account ID for your organization. This is provided after registration.
Step 1: Set up Google as a SAML identity provider (IdP)-
Sign in to your Google Admin console.
Sign in using an account with super administrator privileges (does not end in @gmail.com).
-
In the Admin console, go to Menu AppsWeb and mobile apps.
-
Click Add appSearch for apps.
- Enter Canvas LMS in the search field.
- In the search results, hover over the Canvas LMS SAML app and click Select.
- On the Google Identity Provider details page, download the IDP metadata.
- Click Continue.
- On the Service provider details page, edit the ACS URL, Entity ID, and Start URL, replacing {your-account-id} with your organization’s account ID provided by and registered on Canvas LMS.
- Click Continue.
-
(Optional) To map Google directory attributes to the corresponding app attributes, in the Attribute Mapping window:
- Click Add Mapping.
- Click Select fieldselect a Google directory attribute.
- For App attributes, enter the corresponding app attribute.
-
(Optional) To enter group names that are relevant for this app:
- For Group membership (optional), click Search for a group, enter one or more letters of the group name, and select the group name.
- Add additional groups as needed (maximum of 75 groups).
- For App attribute, enter the groups attribute name of the corresponding service provider.
Regardless of how many group names you enter, the SAML response includes only groups that a user is a member of (directly or indirectly). For more information, go to About group membership mapping.
- On the Attribute mapping page, click Finish.
On a publicly accessible file server, host the Google IDP metadata file downloaded in step 1. The file must be served directly, not via any redirects. The file also needs to be permanently available at a specific URL. It is requested by Canvas LMS each time a user signs in.
- Open a new incognito browser window.
- Sign in to https://{your-account-id}.instructure.com with your organization's Canvas LMS administrator account.
- Click Admin on the left and select Authentication.
- Add SAML as the authentication provider.
- In the IdP Metadata URL field, paste the URL of the Google IdP metadata hosted on the file server as detailed in step 2.
- Click Save. The values of the rest of the fields are populated based on the IdP Metadata.
- Ensure that the Identifier Format selected is nameid-format:emailAddress.
- Ensure that the Authentication Context selected is classes:Password.
- Enable Just in Time Provisioning.
- For SAML authentication, select 1 for Position.
- Click Save.
-
Sign in to your Google Admin console.
Sign in using an account with super administrator privileges (does not end in @gmail.com).
-
In the Admin console, go to Menu AppsWeb and mobile apps.
- Select Canvas LMS.
-
Click User access.
-
To turn a service on or off for everyone in your organization, click On for everyone or Off for everyone, and then click Save.
-
(Optional) To turn a service on or off for an organizational unit:
- At the left, select the organizational unit.
- To change the Service status, select On or Off.
- Choose one:
- If the Service status is set to Inherited and you want to keep the updated setting, even if the parent setting changes, click Override.
- If the Service status is set to Overridden, either click Inherit to revert to the same setting as its parent, or click Save to keep the new setting, even if the parent setting changes.
Note: Learn more about organizational structure.
-
(Optional) To turn on a service for a set of users across or within organizational units, select an access group. For details, go to Use groups to customize service access.
- Ensure that your Canvas LMS user account email IDs match those in your Google domain.
Canvas LMS supports both Identity Provider (IdP) initiated and Service Provider (SP) initiated SSO. Follow these steps to verify SSO in either mode:
IdP-initiated
-
Sign in to your Google Admin console.
Sign in using an account with super administrator privileges (does not end in @gmail.com).
-
In the Admin console, go to Menu AppsWeb and mobile apps.
- Select Canvas LMS.
- At the top left, click Test SAML login.
Canvas LMS should open in a separate tab. If it doesn’t, use the information in the resulting SAML error messages to update your IdP and SP settings as needed, then retest SAML login.
SP-initiated
- Close all browser windows.
- Open https://{your-account-id}.instructure.com. You should be redirected to the Google sign-in page.
- Enter your username and password.
- After your credentials are authenticated, you are redirected back to Canvas LMS.
If the user account authenticated by Google IdP does not already exist in Canvas LMS, a new user account is automatically provisioned by Canvas LMS for the signed-in user.
Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.