D2L API endpoints and scopes Used by the Hypothesis LMS App

The Hypothesis LMS app includes an optional feature set for D2L which allows users to:

• Launch a reading using an specific D2L group category

API endpoints

D2L admins should know that the Hypothesis LMS app accesses the following D2L API endpoints:

• https://docs.valence.desire2learn.com/res/groups.html#get--d2l-api-lp-(version)-(orgUnitId)-groupcategories-

  Retrieve a list of all the group categories for the provided org unit.

• https://docs.valence.desire2learn.com/res/groups.html#get--d2l-api-lp-(version)-(orgUnitId)-groupcategories-(groupCategoryId)-groups-

  Retrieve a list of all the groups in a particular group category for an org unit.

• https://docs.valence.desire2learn.com/res/content.html#get--d2l-api-le-(version)-(orgUnitId)-content-toc

  Retrieve the list of available files in a course's table of contents.

• https://docs.valence.desire2learn.com/res/content.html#get--d2l-api-le-(version)-(orgUnitId)-content-topics-(topicId)

Retrieve metadata for one individual file.

• https://docs.valence.desire2learn.com/res/content.html#get--d2l-api-le-(version)-(orgUnitId)-content-topics-(topicId)-file

  Access to the byte stream of one individual file.

API scopes

Based on the list of endpoints above Hypothesis needs OAuth 2.0 keys scoped with:

For the groups integration:

• groups:group:read

for the files integration:

• content:toc:read
• content:topics:read
• content:file:read