District SSO Certification Guide

How Long Does it Take?

The time to build an integration with Clever varies based on your business needs, data model, and technical constraints.

Certification Process

  1. Build Integration: Complete your Clever integration.
  2. Submit for Certification: Submit your integration for certification review.
  3. Review: Our Partner Engineering team will review your integration based on certification requirements.
  4. Results and Next Steps: Receive an email with your certification results and recommended next steps. If needed, we will schedule a call to discuss your integration in detail.

How Do I Get Started?

  1. Create a Developer Account: Sign up at apps.clever.com/signup.
  2. Refer to Documentation: Check the District SSO with OAuth 2.0 guide.

Checklist

Ensure the following items are complete before submitting for certification:

  • Visit Clever Academy to understand how Clever works.
  • Link users from your Clever sandbox district to users in your system. Provide one working example of SSO for each supported user type.
  • Provide a redirect URI for testing your integration. Set this in your dashboard at Settings >> Instant Login.
  • Ensure supported user types are set in your dashboard at Settings >> Instant Login.
  • Thoroughly test your integration using the Testing Logins guide.
  • Meet the integration requirements listed below.

Integration Requirements

  • Use the authorization grant flow to support SSO.
  • Utilize all relevant data from Clever API.
  • Provide clear indication to users that they are logged in to the correct account.
  • Match users on Clever ID or email address during login.
  • Allow users to log in on the primary redirect URI, secured with HTTPS.
  • Show a friendly error screen when logins fail.
  • Provide a "Log Out" button.

Recommendations

  • Add a "Log in with Clever" button on the login page.
  • Prompt users for required fields not available from the API during first login.
  • Leverage available data from Clever (e.g., name, email).
  • Support UTF-8 characters in names (e.g., ñ, é).
  • Override existing sessions upon new Clever auth requests to support students on shared devices.

Important Questions to Answer

  • Does your integration work in:
    • Chrome
    • Firefox
    • Internet Explorer
    • Safari
    • Mobile Safari
    • Mobile Chrome
  • Do you require fields beyond those provided (e.g., school, district info)? If so, do you prompt the user for these during onboarding?
  • Is there an inactivity timeout after which users are logged out?
  • What screen do users see when they are logged out? Does the window close?