OAuth 2 Clever service

Clever's Requirements

If you're looking to use Clever SSO you must be certified by Clever before you can receive a production instance of Clever. This certification process is for SSO and Rostering (or Secure Sync).

Note: the information below covers SSO, not Rostering.

Clever's "District SSO Certification process" requires you to go through the Clever Academy course to understand how Clever works. It walks you through how to create a sandbox environment, the testing protocols, etc. This process should be reviewed by someone with mid to advanced level technical understanding of how SSO's work.

The certification process is going to require you to have multiple OAuth2 connections where an Instant Link can be tested (test user does not have to type in their district name) and a typical Clever login not using Instant Link (test user does have to type in their district name).

Obtaining a Client ID and Secret

To get a client ID and secret for Clever, you will need to register for a developer account with Clever. To do this, follow these steps:

1. Go to the Clever developer website: https://clever.com/developers/
2. Click on the "Sign Up" button in the top right corner of the page.
3. Fill out the form with your personal and contact information, and agree to the Clever developer terms of service.
4. Submit the form to register for a Clever developer account.

Once you have registered for a Clever developer account, you can access your client ID and secret by following these steps:

1. Log in to your Clever developer account.
2. Click on the "Applications" tab in the top menu.
3. Click on the "Create New App" button.
4. Fill out the form to create a new application, and click on the "Create" button.
5. Your new app will be displayed in the list of applications. Click on the app to view its details.
6. In the app details page, you will see your client ID and secret in the "Credentials" section.

Note: the content of this section has been created using GPT-3.

Moodle-Specific Procedures

As of Moodle 4.1, there is a Clever button in OAuth2 settings, however, Clever will work on earlier versions.

To pass Clever’s testing requirements, you should be able to demonstrate an Instant Link connection and a non-Instant Link connection. They can be tied to the same login page.

Set up non-Instant Link configuration

1. Visit Site Administration > Server > OAuth 2 services
2. Click Custom
3. Name should be Clever
4. Enter your Client ID. You would have received this information when you created your Developer account at Clever.
5. Enter your Client secret. You would have received this information when you created your Developer account at Clever
6. Tick "Authenticate token requests via HTTP headers"
7. Set service base URL to "https://clever.com"
8. Set "The service will be used" to "Login Only"
9. Uncheck Require email verification
10. Save changes
11. Test your set up with expectation that the test user needs to search for their district

Set up Instant Link configuration

1. Visit Site Administration > Server > OAuth 2 services
2. Click Custom
3. Name should be Clever Instant Link
4. Enter your Client ID. You would have received this information when you created your Developer account at Clever.
5. Enter your Client secret. You would have received this information when you created your Developer account at Clever.
6. Tick "Authenticate token requests via HTTP headers"
7. Set service base URL to the full URL provided to the Vendor/Client for Instant Link setups
8. Set "The service will be used" to "Login Only"
9. Uncheck Require email verification
10. Save changes
11. Test your set up with expectation that the test user does not need to search for their district