LMS - Blackboard Learn
Table of Contents
1. Blackboard Learn Integration Requirements
Step 1: Setup a new API user for Ready Education
Navigate to “Administrator Panel” → “Users”
Create a System Role and restrict all default privileges associated with the new role
Add the permissions listed below in section 2. to the new role
Create a new user, assign the new system role to this user
Step 2: Create an integration for the Ready Education application
Under “Administrator Panel” → “Integrations” → “REST API Integrations”
Use the following Application ID:
34ace4e4-8469-415a-9975-91c4f0248e50Bind to the Learn user created in Step 1
“End user access” is not required
“Authorized to act as user” is not required.
Step 3: Create Test User
Provide a test user account that can pass authentication, and has overlapping course data in both your SIS and LMS. Click here to view more information about our test user requirements: Test User and Test Data Requirements.
2. Required Permissions and Endpoints Used
Privilege Description | Endpoint | Purpose |
Administrator Panel (Courses) > Courses > Edit > Course Properties | /learn/api/public/v3/courses | Find courses |
Administrator Panel (Users) > Users | /learn/api/public/v1/users | Get student details |
Administrator Panel (Users) > Users > Edit > View Course Enrollments | /learn/api/public/v1/users/{userId}/courses | Get student enrollments |
Administrator Panel (Users) > Users > Edit > View Organization Enrollments | /learn/api/public/v1/users/{userId}/courses | Get student enrollments |
Administrator Panel (Courses) > Terms | /learn/api/public/v1/terms/{termId} | Get term details |
Course/Organization (Content Areas) > View Material Settings | /learn/api/public/v1/courses/{courseId}/contents | Get Assignments, |
Course/Organization Control Panel (Grade Center) > View Grades | /learn/api/public/v2/courses/{courseId}/gradebook/users/{userId} | Get student grades for course |
Course/Organization Control Panel (Grade Center) > View Attempts | /learn/api/public/v2/courses/{courseId}/gradebook/columns/{gradeColumnId} | Get grade details, Get Assignment/Quiz due dates |
Course/Organization Control Panel (Tools) > Announcements | /learn/api/public/v1/courses/{courseId}/announcements | Get announcements |
Course/Organization Control Panel (Tools) > Calendar | /learn/api/public/v1/calendars/items | Get calendar items |
Course/Organization Control Panel (Grade Center) > View Grades | /learn/api/public/v2/courses/{courseId}/gradebook/columns | Get grade column details, |
Note: We will require you to add additional privileges to support the “Discussions” functionality. This is being tested and validated by our development team.
3. Provide the following information to your Implementation Project Manager
Provide the following information to your Implementation Project Manager to create a ticket.
Blackboard Admin User credentials (provide via privnote.com)
Blackboard URL (Test and Prod)
Test user credentials (provide via privnote.com)