❗️

Clever Complete Requirement

Please note that you must have signed a Clever Complete agreement to build a Clever Single Sign-On integration.

A Clever Library integration can be built without a Clever Complete agreement and is free of charge.

Table of Contents

Overview
Audience
authorized_by Field
Scopes and Available Data Points
User Registration
Testing
Certification

---

Overview

Both Clever Library and Clever Single Sign-On use the same authorization grant flow with Clever. As such, it's very easy to get them confused. This documentation should help you avoid getting the two mixed up when it comes time to certify.

While this information can all be found throughout our documentation, this page will hopefully serve as a one-stop-shop for helping you understand the key differences and similarities between the two integration types.

📘

Check out these key resources for a high level understanding of Clever's integrations

• Clever Integration Types
• Clever Certification Types

---

Audience

Clever Single Sign-On

Clever Single Sign-On supports district admins, school admins/staff, teachers, and students. An application building out this integration type can choose any subset of these user types to allow SSO for.

Clever Library SSO

Clever Library only supports teachers and students. Other user types cannot use this integration type. The idea behind Clever Library SSO is to allow teachers to try out new software at their classroom level.

🤔

What if my app supports both Clever Single Sign-On and Clever Library?

Clever prioritizes the highest level of integration for SSO requests:

Users that are shared with only one of these integrations (e.g., a teacher adds your app via the Clever Library) will be redirected to that specific integration.

Users that are shared with both integrations, will be redirected to the highest level integration, which will be the Clever Single Sign-On (district level integration), since the Clever Library integration only operates at the Classroom level.

---

authorized_by Field

❗️

Versions matter!

Please note that the authorized_by property is only available on v3.0+ of our API.

Clever Single Sign-On

The district must authorize these connections in order for them to work. Districts do this by connecting to an application at the district level and then setting up sharing permissions. More on these processes can be found in the documentation below:

• Connecting with Districts
• Sharing Permissions

Below is an example of how you can identify a Clever Single Sign-On authentication request using the /me endpoint. Notice "authorized_by" is set to "district".

{
    "type": "user",
    "data": {
        "id": "5fc43758db087d0be186c29d",
        "district": "5d0a9e5d0958b300014e49d2",
        "type": "user",
        "authorized_by": "district"
    },
    "links": [
        {
            "rel": "self",
            "uri": "/me"
        },
        {
            "rel": "canonical",
            "uri": "/v3.0/users/5fc43758db087d0be186c29d"
        },
        {
            "rel": "district",
            "uri": "/v3.0/districts/5d0a9e5d0958b300014e49d2"
        }
    ]
}

Clever Library

Teachers authorize these connections. In order for a student to access a Clever Library application, they must be part of a section belonging to a teacher that has authorized a connection with that application. More on Clever Library can be found in the articles below:

• For Teachers: Connecting with Clever Library
• For Clever Admins: Managing the Clever Library
• Below is an example of how you can identify a Clever Library SSO authentication request using the /me endpoint. Notice "authorized_by" is set to "teacher".

{
    "type": "user",
    "data": {
        "id": "607741faddeea003f1bb6cfd",
        "type": "user",
        "authorized_by": "teacher"
    },
    "links": [
        {
            "rel": "self",
            "uri": "/me"
        },
        {
            "rel": "canonical",
            "uri": "/v3.0/users/607741faddeea003f1bb6cfd"
        }
    ]
}

---

Scopes and Available Data Points

As always, please refer to https://clever.com/schema for a comprehensive overview of field-level access for each integration type.

Clever Single Sign-On

Clever Single Sign-On gives access to the following fields:

Clever Library

Clever Library gives access to the following fields:

🚧

Missing Required Fields?

If these integration types don't give you access to fields that are considered "required" in your application, simply collect that information upon their first login.

---

User Registration

Clever Single Sign-On

Because you are limited in the information you receive for this integration type, it is common to first provision the users through Clever Secure Sync, another rostering service, or manual provisioning as a prerequisite to integrating. In some cases, there are applications that auto-provision on their first login using the fields available.

Clever Library

With Clever Library, it is expected for you to auto-register a new teacher when they first "install" your Library application. For students, you should auto-provision their account as soon as their teacher authorizes the connection.

---

Testing

Clever Single Sign-On

🚧

Do not use the Clever Library Integration Guide in your Dashboard!

Clicking around the dashboard, you may come across an "Integration Guide". This is specifically for the Library integration. Testing using this tool may result in some confusion during the certification process. Please be sure to instead use the documentation linked directly below to test your Clever Single Sign-On integration.

• Testing - District SSO

Clever Library

• Testing - Library

---

Certification

You can certify for both of these integrations on the same client credentials at the same time and using the same certification survey! Please be sure to review the certification guides linked below:

Clever Single Sign-On

District SSO Certification Guide

Clever Library

Library Certification Guide