LTIAAS
The LTIAAS API allows you to easily access the various LTI 1.3 Advantage services and functionalities like SSO, grade manipulation and roster retrieval.
Using the LTIAAS API
To learn how to use our API to build your very own LTI integration, please check our detailed guides.
Retrieve the ID Token and perform SSO
The ID Token is the main piece of data in the LTI protocol, it's sent by the LMS to the LTI tool and contains information regarding the current LTI launch, this includes user information, LMS information, launch context information and everything you need to use the many LTI services.
You can use the information contained in the ID Token to perform SSO and authenticate users into your application, automatically logging them into a preexisting account or provisioning a new one on the spot. To learn more about this, please check our Retrieving ID Token guide and its Performing SSO section.
Retrieve roster information
The LTI protocol allows you to retrieve roster information for an LMS context through the Names and Roles Provisioning service. LTIAAS gives you access to this service through the Memberships API endpoint. To learn more about this functionality, please check our Retrieving course roster guide.
Manipulate user grades
The LTI protocol allows you to manipulate user's grades and LMS grade lines through the Assignment and Grades service. LTIAAS gives you access to this service through the Line Items API endpoint. To learn more about this functionality, please check our Manipulating grade lines guide and Manipulating grades guide.
Serve multiple resources through your LTI tool
If your application is a hub of multiple resources and/or activities, the LTI protocol makes this easy to manage through the Deep Linking service. You can use this service to allow teachers and administrators to select one specific resource from your application when creating an activity in the LMS. LTIAAS gives you access to this service through the Deep Linking flow and API endpoint. To learn more about this functionality, please check our Performing Deep Linking guide.
Authenticating API requests
Please check our guide on Authenticating API requests to learn about how authentication works in the LTIAAS API.
Authentication
An http Header who's value is of the format: LTIK-AUTH-V2 <API_KEY>:<ltik>. Where <API_KEY> should be replaced with your static API Key provided by LTIAAS and <ltik> is the ltik value passed to you on each new launch of your tool. Learn more about this in the Authenticating API requests guide.
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | Authorization |
An http Header who's value is of the format: SERVICE-AUTH-V1 <API_KEY>:<SERVICE_KEY>. Where <API_KEY> should be replaced with your static API Key provided by LTIAAS and <SERVICE_KEY> is the service key value obtained from an idtoken. Learn more about this in the Authenticating API requests guide.
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | Authorization |
