Connect Blackboard
For LMS administrators
This guide covers the full Blackboard Learn setup, in the order the screens have to be completed. It applies to Learn SaaS, with Ultra and Original courses. Setup takes about thirty minutes, and you need the System Administrator role in Learn.
For what the integration does once it is set up, read How the integration works.
What you are setting up
Section titled “What you are setting up”Blackboard keeps the two halves of the integration on separate screens. You need both.
| REST API integration | LTI tool | |
|---|---|---|
| Where | Integrations → REST API Integrations | Integrations → LTI Tool Providers |
| What it does | Lets Odea read course content and rosters | Lets users launch Odea and proves who they are |
| Created in | Steps 1 and 2 | Steps 3 and 4 |
| You give us | Nothing | The Deployment ID and your Learn URL |
With only the LTI tool, launches work but no course materials import. With only the REST integration, nothing launches at all.
One Application ID covers both. Blackboard calls the same value the Application ID on the REST screen and the Client ID on the LTI screen. It is a single value, and every institution uses the same one. Email [email protected] to get it before you start.
Blackboard renames menu items between releases. In this guide, Administrator Panel is the page you reach through Admin in the Ultra base navigation, or the System Admin tab in the original experience. If a label differs on your instance, match it by meaning.
Before you start
Section titled “Before you start”You need:
- The Application ID from us
- A System Administrator account in Learn
- The address of your Learn site, for example
https://your-university.blackboard.com
Step 1: Create the integration user
Section titled “Step 1: Create the integration user”Blackboard requires every REST integration to name a Learn user. Create one for Odea, so it has no connection to a real person’s account.
First create a role with no privileges.
-
Go to Administrator Panel → Users → System Roles.
-
Click Create Role.
-
Set Role Name to
Odea Integration. -
Set Role ID to
OdeaIntegration. -
Click Submit. Do not permit any privileges on this role.
Then create the user.
-
Go to Administrator Panel → Users → Users.
-
Click Create User.
-
Set First Name to
Odeaand Last Name toIntegration. -
Set Username to
odea_integration. -
Set a long random Password. Nobody signs in with this account, and we do not need the password.
-
Set System Roles to
Odea Integration. -
Click Submit.
Only the privileges on the System Role count. The Institution Role has no effect on what an integration can do.
Step 2: Create the REST API integration
Section titled “Step 2: Create the REST API integration”-
Go to Administrator Panel → Integrations → REST API Integrations.
-
Click Create Integration.
-
Paste the Application ID we sent you.
-
Next to Learn User, click Browse and select
odea_integration. -
Set End User Access to Yes.
-
Leave Authorized To Act As User at its default.
-
Click Submit.
End User Access is the setting that matters. With Yes, each educator signs in with their own Learn account and approves Odea once, and Odea can then reach only what that educator can reach. With No, every call would run as the integration user, which has no access to any course.
Step 3: Register the LTI tool
Section titled “Step 3: Register the LTI tool”-
Go to Administrator Panel → Integrations → LTI Tool Providers.
-
Click Register LTI 1.3/Advantage Tool.
-
Paste the Application ID into Client ID.
-
Click Submit.
-
On the page that follows, set Tool Status to Approved. A tool that is not approved will not launch.
-
Under Institution Policies, set the fields as listed below.
-
Copy the Deployment ID and keep it for step 5.
-
Click Submit.
Institution Policies
Section titled “Institution Policies”| Field | Value | Why |
|---|---|---|
| User Fields to Send: Role in Course | Selected | Odea derives the user’s role from it |
| User Fields to Send: Email Address | Selected | Required. A launch without an email address is refused |
| User Fields to Send: Name | Not selected | Odea does not use it, so there is no reason to send it |
| Allow grade service access | No | Odea writes no grades |
| Allow Membership Service Access | No | Rosters come through the REST integration |
| Show User Acknowledgment Message | No | Your choice, but it adds a click to every launch |
The domain and URLs on this page come from our registration. You do not enter them, but you can compare them with these values:
| Field | Value |
|---|---|
| Domain | lti.odea.education |
| Login Initiation URL | https://lti.odea.education/lti/login |
| Tool Redirect URL | https://lti.odea.education/lti/launch |
| Tool JWKS URL | https://lti.odea.education/lti/jwks |
Step 4: Create the placement
Section titled “Step 4: Create the placement”The placement decides where Odea appears in a course. Without one, the tool is installed but nobody can reach it.
-
On LTI Tool Providers, open the menu next to Odea.
-
Click Manage Placements.
-
Click Create Placement.
-
Set Label to
Odea. -
Set Handle to
odea. -
Set Availability to Yes.
-
Set Type to Course tool.
-
Select Allow student access and Allow non-student access.
-
Select Launch in New Window.
-
Set Target Link URI to:
https://lti.odea.education/lti/launch -
Paste this into Tool Provider Custom Parameters:
blackboard_course_id=@[email protected]_string@X@ -
Click Submit.
Two settings here fail in ways that are not obvious:
- Launch in New Window must be selected. Without it, Learn opens Odea inside a frame, where browsers block the sign-in cookie and the frame stays blank.
- Allow student access must be selected. Without it, educators can launch Odea and students cannot find it.
The custom parameter tells Odea which course a launch belongs to, in the form the REST API uses.
Where people find Odea
Section titled “Where people find Odea”| Ultra course | Original course | |
|---|---|---|
| Without any action | Books & Tools | Tools in the course menu |
| Added by an educator | Not needed | A Tool Link in the course menu, for one-click access |
Running a pilot
Section titled “Running a pilot”Installing the tool reads nothing. Odea touches a course only after an educator on that course connects it, so a pilot can run on the institution-wide placement.
To keep Odea out of sight for everyone else, set Type to Course content tool instead. Odea then appears only where an educator adds it, through Content Market in Ultra or Build Content in Original.
If your site uses the Institutional Hierarchy, check that the tool is available on the nodes that hold your pilot courses.
Step 5: Send us your details
Section titled “Step 5: Send us your details”Blackboard uses one issuer and one Client ID for every institution in the world. The Deployment ID is the only value that tells us a launch came from your site, so Odea cannot accept your launches until we have it.
-
Open LTI Tool Providers and click the menu next to Odea.
-
Click Edit and copy the Deployment ID, if you did not save it in step 3.
-
Email [email protected] with the items listed below.
What to send us
None of these are secrets. Do not send us the integration user’s password, because we do not need it.
Step 6: Institution verification
Section titled “Step 6: Institution verification”A person reviews every Blackboard registration, because *.blackboard.com addresses
identify the vendor rather than your school. We confirm within one working day.
The email domains matter. A launch is refused when the user’s address does not match a domain registered to your institution, so include secondary domains such as a hospital or research institute.
What educators and students see
Section titled “What educators and students see”The first educator to launch Odea from a course reaches a setup page. They sign in to Learn and click Allow to let Odea read on their behalf, then link the course and choose which materials the AI may use. This takes a few minutes and happens once per course.
A student who launches a course the educator has not set up yet sees a page explaining that the course is not ready.
Once a course is set up, students click Odea and are signed in, with no separate account or password.
What comes across
Section titled “What comes across”| From Learn | In Odea |
|---|---|
| Course | The Odea course |
| Content folders and learning modules | Folders, with the same structure |
| Ultra documents | Readable content |
| Files, and attachments on Original items | Course materials the AI can use |
| Course memberships | Enrolments, with roles mapped from Learn |
Content hidden from students stays out of Odea. Odea does not read grades, tests, assignments, discussions or announcements, and it writes nothing to Learn.
Syncs start when an educator connects or refreshes a course. If your institution has scheduled sync switched on, Odea also refreshes courses at 08:00, 12:00 and 16:00 Central European Time on weekdays.
API calls Odea makes
Section titled “API calls Odea makes”For a security review, these are the calls involved. All content calls are GET, and the
requested OAuth scopes are read and offline. Educators approve them once, and offline
lets a sync run without a new sign-in.
| Purpose | Endpoint |
|---|---|
| Sign-in and approval | /learn/api/public/v1/oauth2/authorizationcode |
| Token exchange | /learn/api/public/v1/oauth2/token |
| The educator’s courses | /learn/api/public/v1/users/{userId}/courses |
| Course details | /learn/api/public/v3/courses/{courseId} |
| Class list | /learn/api/public/v1/courses/{courseId}/users |
| Course content | /learn/api/public/v1/courses/{courseId}/contents |
| Items in a folder | /learn/api/public/v1/courses/{courseId}/contents/{contentId}/children |
| Attachments on an item | /learn/api/public/v1/courses/{courseId}/contents/{contentId}/attachments |
| File download | .../attachments/{attachmentId}/download |
Course copies and new terms
Section titled “Course copies and new terms”A copied course has a new course ID in Learn. Odea resolves the course from the launch every time rather than binding it to the link, so a copy is treated as a new course. The educator is walked through setup again, and students see the “not ready yet” page until that is done.
Launches never break, and they never serve the previous term’s materials.
Troubleshooting
Section titled “Troubleshooting”Blackboard-specific problems are below. For issues common to every LMS, see Troubleshooting LTI launches.
Your registration uses production-backend.odea.education. That address still works,
so you do not need to register Odea again.
Every launch is refused. Check that Email Address is selected under Institution Policies. If it is, check that we have your Deployment ID.
The tool opens a blank frame. Launch in New Window is off on the placement.
Odea does not appear in a course. Check that Tool Status is Approved, the placement’s Availability is Yes, and you created a placement at all. In Ultra, look under Books & Tools rather than in the course content.
Educators see Odea but students do not. Allow student access is off on the placement.
Registering the Client ID fails. Check for a stray space in the pasted value. If the error mentions a site or quota limit, the limit is on our side, so email us.
Launches work, but the educator cannot approve access. End User Access is set to No, or the integration has been made unavailable. See step 2.
Launches work, but no course materials appear. The REST integration is missing, or the educator has not connected the course yet.
A large sync slows down. Blackboard limits how many REST API calls an application can make in 24 hours. Odea picks up where it left off, and you do not need to act.
Everyone appears as a student. Role in Course is not selected under Institution Policies.
Data and privacy
Section titled “Data and privacy”- Received per launch: issuer, a stable user identifier, email address, role in course and course ID.
- Received through the REST integration: course content, materials and class lists, for the courses educators choose to connect.
- Hosting: processed and stored in the EU on Google Cloud. Encrypted in transit (TLS 1.2 and above) and at rest (AES-256).
Full detail is in the Trust Center and the privacy policy.
Still stuck?
Section titled “Still stuck?”Email [email protected] with your Learn URL, your Deployment ID, and a description of what the user saw.