Home > Guides > LMS > Brightspace

Brightspace - FAQ

(for LMS admin)

• I am trying to integrate my Brightspace OAuth 2.0 App with Willo Labs but how do I login to Willo Labs?

  In the Willo Labs OAuth 2.0 App Integration guide you will need to login to Willo Labs by just providing your LMS admin email address. You will get a direct login link sent to your email, you use this link to complete login, i.e no password required.

  If you get an Email address not found notice, then please let the Aktiv Team know about this so they can add your email address. Email template:

  “Please add my email address [example@mycollege.com] to the LMS Admin Email List in the Willo Labs Customer setup for my institution [Example College].”

• I am trying to integrate my Brightspace OAuth 2.0 App with Willo Labs but why does the Grade Sync Mode say ‘LTI’ and not ‘Brightspace API’?

  This is something that needs to fixed by the Aktiv Team, please email them.

  “The Grade Sync Mode in the Willo Labs Customer Access area for [My Institution] is showing up as LTI instead of Brightspace API, please fix.”

• What permissions/data does Aktiv require from Brightspace?

  The Aktiv app is installed as an LTI external tool. Any courses launched from LMS will thus pass the Course ID (LTI ContextID), as well as information about the instructor or student making the launch (such as their LTI userId and email).

  With this, Aktiv can perform a grade sync for that course for each of the students that have launched.

• What additional permissions/data does Aktiv require from Brightspace to perform multi-column syncing?

  For Aktiv to perform gradebook syncing, we also require a Brightspace OAuth 2.0 App.

  Aktiv Actually performs the API calls via an intermediary (Willo Labs, Inc.).

  The actual Client ID and Client Secret (i.e the credentials) of the Brightspace OAuth 2.0 App are not required to be shared with Aktiv or Willo Labs. The LMS Admin following the Willo Labs OAuth 2.0 App Integration guide, essentially provides the OAuth 2.0 app credentials into a client widget in which they then proceed to authorize the app to get an intial token associated with that oauth app. From then on, Aktiv uses this token (and refreshed versions of it) to access the LMS.

  Please see also the permissions used by our intergration partner Willo Labs, Inc..

  Role Permissions Required for API Grade Sync

  1. Classlist
     • Has Access to the Classlist
     • View and Modify Flagged Status
  2. Course Management Console
     • See Course Info
  3. Grades
     • See the grades tool
     • Enter Grades
     • Manage Grades
     • Manage Items and Categories
     • See user grades values (API Only)
  4. Content
     • Push deep links back into Brightspace

  API Scopes

  • core:*:*
  • grades:gradeobjects:delete
  • grades:gradeobjects:read
  • grades:gradeobjects:write
  • grades:gradevalues:read
  • grades:gradevalues:write
  • Enrollment:orgunit:read
  • Content: *:*

  API Endpoints

  1. whoami
     • _{^{GET /d2l/api/lp/(version)/users/whoami}}
     • Retrieve the current user context’s user information. Used by Willo Labs to test the API connection to the Brightspace instance.
  2. Get Grade Objects
     • _{^{GET /d2l/api/le/(version)/(orgUnitId)/grades/}}
     • Retrieve all the current grade objects for a particular org unit. Used by Willo Labs to determine if a grade object already exists in the course, or if a new grade object should be created.
  3. Get Grade Object
     • _{^{GET /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)}}
     • Retrieve a specific grade object for a particular org unit. Used by Willo Labs to determine if a previously created grade object still exists.
  4. Delete Grade Object
     • _{^{DELETE /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)}}
     • Delete a specific grade object for a particular org unit. Used by Willo Labs to delete a previously created grade object when there is an upstream error mapping a grade object to a grade column the integrated product gradebook.
  5. Create Grade Object
     • _{^{POST /d2l/api/le/(version)/(orgUnitId)/grades/}}
     • Create a new grade object for a particular org unit. Willo Labs maps the newly created grade object to a grade column in the integrated product gradebook.
  6. Update Grade Object [future use]
     • _{^{PUT /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)}}
     • Update a specific grade object. Used by Willo Labs to update grade object name to reflect current name in product gradebook.
  7. Update Column Grade
     • _{^{PUT /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)/values/(userId)}}
     • Provide a specific grade value for a particular user. Used by Willo Labs to post a student’s grade from the integrated product into the Brightspace course gradebook.