GuidesAPI Postman CollectionSupportStatusClever Academy
Guides

Clever Integration Types

Integration Options with Clever

When setting up your integration with Clever, you have three options:

  1. District Single Sign-On (SSO) integrations are managed by district administrators. Your application can be added through the Request Application page of the district dashboard. This integration facilitates SSO for any Clever user scoped by a district administrator. To learn more, see the District SSO Certification Guide.
  2. Rostering (Secure Sync) integrations are also managed by district administrators. Your application can be added through the Request Application page of the district dashboard. This integration allows you to pull district, school, user, and enrollment data via the Clever API, provided the district shares the data. To learn more, see the Secure Sync Certification Guide.
  3. Clever Library SSO and Rostering integrations are teacher-initiated. Teachers add your application through the Clever Library and can provision accounts on-demand for themselves and their students. To learn more, see the Library Certification Guide.

📘

Development App Scopes

By default, your Clever development app will have Library (Classroom) scopes in addition to District SSO scopes. For rostering scopes, contact [email protected].


Integration Differences

Clever App Options

District Rostering and SSO

Secure Sync allows you to access user information and provision accounts in advance, optimizing your core product. For Secure Sync access, contact [email protected].

District Integration Experience

District administrators can search for your application in the district dashboard and scope access to all users within the district. With a district-level integration, your application can be scoped to all users who need access within a district. Once data is shared, all scoped users' data will be available via the district-app token, allowing you to roster and provision accounts at scale.

User Login Methods

  1. Clever Portal: Primary launch point for many districts into their applications.
  2. Instant Login Links: Embedded links used to log a district's users into a specific application through Instant Login.
  3. Log In With Clever: "Log in with Clever" buttons embedded on your website for direct user authentication.

Data Shared via Secure Sync

Secure Sync provides full access to roster information, including student-teacher associations and classroom-level data. OAuth tokens can be retrieved from your App Dashboard or via our API. Upgrading to District Certification allows access to the entire Data API, matchmaking tools, Data Browser, and more. Refer to our schema for a full list of available fields in Clever.


📘

Available Fields

For a detailed list of available fields in each integration type, see the Clever API Schema.

📘

Working with Districts

Learn how applications connect with districts:

Library (Classroom) Rostering and SSO

Library Integration Experience

When a teacher clicks on a new app in the Clever Library or the ‘Sign Up with Clever’ button, they see a consent screen to authorize Clever to share their section (class) data with the app. After authorization, Clever redirects the teacher to your app, and you facilitate the OAuth Single Sign-On flow using API calls to query the user’s identity and classroom information. The teacher’s account is provisioned immediately, and they are logged in to a free or freemium experience with their section and student data populated. The app is added to the Clever Portal for the teacher and their shared students, allowing student logins as well.

Teacher Sign-Up Entry Points

  1. Teachers finding you through the Clever Library and clicking “Install”.
  2. Teachers clicking the “Sign Up with Clever” button on your website’s teacher signup page.

Data Shared Upon Teacher Consent

Teacher Object Data

  • Clever ID (unique and stable ID created by Clever)
  • Name (first, middle, last)
  • Email

Teacher’s Shared Sections

  • Clever ID
  • Name
  • Section number
  • Teachers
  • Students
  • Subject (normalized to a set of possible values)
  • Grade (if available from the SIS)

Student Object Data in Those Sections

  • Clever ID (a GUID generated by Clever)
  • Name
  • Grade (if available from the SIS)

❗️

Accessing District and School Data

You cannot access District or School level data with default Library (Classroom) scopes. Contact [email protected] to gain access.

📘

Working with Teachers

Learn how applications connect with teachers:

Updated 2 months ago

What’s Next