Integration Flows

The guides in this section walk through each part of an LTIAAS integration from end to end, illustrating the flow of data between the LMS, LTIAAS, and your application. Where the LTI® API reference describes individual endpoints in isolation, these flow guides show how those endpoints fit together to accomplish a complete task — registering an LMS, embedding content, signing a user in, or sending a grade back to the gradebook.

Each guide is also explicit about the division of responsibility. LTIAAS handles the LTI® protocol — the OIDC handshakes, JWT signing and verification, and service proxying — while your application is responsible for the pieces that are unique to your product, such as the Deep Linking content selection view, the user provisioning that backs single sign-on, or the background jobs that reconcile grades. Every flow calls out which steps belong to which side.

If you're building an integration for the first time, it's recommended to read the flows in order: registration establishes the trust between the LMS and your tool, launch and SSO turn a launch into a logged-in user, and the remaining flows layer on the optional Deep Linking, Assignment and Grades, and Names and Roles Provisioning services.

1. 1

   Dynamic LMS Registration

   required

   Connect your tool to an LMS through Dynamic Registration, including the optional pre-approval flow for gated or paid tools.

   Walk through →
2. 1b

   Manual LMS Registration

   required

   Register an LMS that doesn't support Dynamic Registration, or register programmatically through the /admin/platforms API.

   Walk through →
3. 2

   Deep Linking

   recommended

   Allow a teacher to select a resource from your tool and embed it into an LMS assignment. Your application provides the content selection view.

   Walk through →
4. 3

   Launch + idtoken SSO

   required

   Turn an LTI® launch into a logged-in session in your application's own authentication system, with patterns for sessions, JWTs, and identity providers.

   Walk through →
5. 4

   Grade Passback

   recommended

   Locate or create the line item for an activity, then submit a per-user score to the LMS grade book through the Assignment and Grades service.

   Walk through →
6. 5

   Names & Roles (Roster Sync)

   optional

   Retrieve the class roster for a context through the Names and Roles Provisioning service, then map roles and upsert members into your database.

   Walk through →
7. 6

   OAuth2 with the LMS API

   optional

   Reach beyond the LTI® services into the LMS's native REST API (Canvas, Brightspace) for files, enrollments, and advanced gradebook operations.

   Walk through →
8. 7

   Async / Service-Key Grading

   optional

   Submit grades and refresh rosters from cron jobs or background workers using the service key, with guidance on retries, idempotency, and monitoring.

   Walk through →