Introduction

Institution-Level User APIs are a set of JSON APIs that allow a client to programmatically manage users within the institution.

Set-Up

Prior to using the Org-Level User Management APIs, you will need to request an API Key and Secret. Then, you will connect it to your preferred course(s) and/or link it to your whole institution.

This article, How to Request and Set Up an API Key and Secret, walks through the process of requesting and setting up the API Key and Secret.

Endpoints

There are eight endpoints:

1. GET Available roles
2. GET Custom Profile List
3. PUT Update Custom Profile
4. PUT Update Email
5. PUT Update External ID
6. GET User
7. PUT Update User
8. POST Create User

Developer Documentation

Institution-Level User APIs 

Rate Limiting

We ensure the integrity of our API endpoints, NovoEd limits usage of our API on a per-key basis. Here are the rate limits:

“Time span” is determined by when a request first comes in. Within the next time span, the requestor cannot exhaust the number of requests allowed within that time period.