Setting up District SSO

📘

Before you continue reading

Be sure that you have a basic understanding of how the OAuth 2.0 authorization grant flow works with Clever. See Getting Started with Clever SSO

You will also need to ensure that you already have access to a developer dashboard at https://apps.clever.com. If you do not, please create one at https://apps.clever.com/signup. If a team member of yours has already created a dashboard, they can add you by referring to this article

Developer Dashboard

Before you even begin building your SSO integration, it's important to familiarize yourself with the Clever developer dashboard.

When you log in to your developer dashboard, you should arrive at the landing page, as shown below:

Take this opportunity to click around and explore! Here is a brief guide on the different elements of the dashboard:

• Home
  • This is where your district connections will be managed. By default, your developer account should already be connected to a sandbox #DEMO district. This district contains test users that can be used later on in development.
• Clever Training
  • This is a link to some Clever training modules that will be helpful in familiarizing you with the Clever ecosystem, including the district perspective.
• Data Browser
  • This feature allows you to browse the population of users and other Clever objects connected to your application. You will not have access to this feature if you don't have the Secure Sync access tier.
• Analytics
  • This page will provide basic usage data on your SSO integration once it is connected with production users.
• Dev Tools
  • This group of pages includes developer documentation links and tooling that will not be relevant to this integration type.
• Library + App Store
  • This group of pages includes tooling and resources specifically for the Library and App Store integrations and will not be relevant to this integration type.
• Settings
  • Includes basic application information fields, client credentials, and SSO settings. It is important that you become familiar with this page.
• Team
  • Allows the dashboard owner(s) to manage users who will have access to the dashboard.

Settings

Once you are ready, click into your Settings as highlighted by the green box in the image above.

Notice that there are three different tabs:

• General
  • Profile Settings: You can provide some basic information about your application
  • API Credentials: You can use these credentials to access the Clever identity API when building your SSO integration
  • Image Settings: This area shows the icon that will be displayed to district users once your application is certified. At this time, you are unable to update this image in the dashboard. If you need, you can send your icon to [email protected] in 200x200 png format.
  • Additional Info: This section contains your API scopes. For the District SSO access tier, you should have the following scopes:
    • read:district_admins_basic, read:school_admins_basic, read:students_basic, read:teachers_basic, read:user_id
• Integration

A few of the the settings in this page are REQUIRED when building an SSO integration with Clever.

• OAuth Settings (REQUIRED):
  • This section contains the redirect URIs that will be used for your SSO integration. The URIs provided here will be associated with the services you build to process an authentication request from Clever. Please note that you can add multiple redirect URIs to this list by adding each subsequent one in a new line. It's worth noting that unless otherwise specified, Clever will default to the first redirect URI in the list. Be sure to account for this in during development. You can expand the box by dragging the hash mark in the lower right corner.

• Additional Settings (REQUIRED):
  • This section contains Supported User Types. This setting controls which user types have access to SSO through your integration. Be sure to set this up correctly and consider which user types you will be serving with this integration.

• Enable events:
  • This setting is not relevant to this integration type

Building the Integration

You're now ready to get started! Please refer to OAuth Implementationfor an in-depth guide on what SSO looks like with Clever.