SAKAI LTI Configuration Guide

This guide explains how to configure a Sakai LTI 1.3 integration with Apporto NextGen and complete the first launch that provisions the user in Apporto.

Overview

The configuration requires work in two systems:

  • Sakai (Administration Workspace > External Tools) to register the Apporto tool and obtain the LTI 1.3 platform values

  • Apporto NextGen to create the LTI configuration using those values

Once setup is complete, the tool can be launched from a Sakai site. The first launch creates the user in Apporto.

Prerequisites

  • Administrator access to the Sakai instance (Administration Workspace)

  • Administrator access to the Apporto NextGen environment

  • A publicly reachable Apporto instance URL (do not use localhost)

  • A Sakai site available for launch testing (for example, Next Gen)

Step 1: Sign in to both platforms

  1. Log in to Sakai using administrator credentials. Example: https://qa21-mysql.nightly.sakaiproject.org/

  2. Log in to Apporto NextGen as an administrator. Example: https://{instancename}.apporto.com

Step 2: Register the Apporto tool in Sakai

  1. In Sakai, go to Administration Workspace > External Tools.

  2. Click Install LTI 1.x Tool.

  3. Enable LTI 1.3 for the tool and complete the registration fields using the values below, then save the tool.

Field

Value / Guidance

Tool Name / Title

Apporto (or any display name). Example: NextGen

OIDC Login Initiation URL

https://{instancename}.apporto.com/api/auth/lti/v2/sakai/login

Redirect URI / Launch URL

https://{instancename}.apporto.com/api/auth/lti/v2/sakai/launch

Public Keyset URL

https://{instancename}.apporto.com/api/auth/lti/v2/sakai/keys

  1. The tool now appears in the External Tools list.

    sakai-external-tools-list.png

Step 3: Get the LTI 1.3 values from Sakai

  1. In External Tools, click your tool (in this example, NextGen) to view its configuration.

    Sakai shows the configuration information to provide to the tool. Copy the values below for Step 4.

    sakai-tool-config.png

Field

Value / Guidance

LTI 1.3 Client ID (provide to the tool)

Used as the Apporto Client ID.
Example: bdf44c9d-8a71-4518-96e6-c6e7030cf314

LTI 1.3 Issuer for this Platform (provide to tool)

Used as the Apporto LTI Base URL.
Example: https://qa21-mysql.nightly.sakaiproject.org

LTI 1.3 Platform OIDC Authentication URL (provide to tool)

Used as the Apporto Auth Login URL.
Example: https://qa21-mysql.nightly.sakaiproject.org/imsoidc/lti13/oidc_auth

LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL (provide to tool)

Used as the Apporto Auth Token URL.
Example: https://qa21-mysql.nightly.sakaiproject.org/imsblis/lti13/token/1

Step 4: Create the LTI configuration in Apporto NextGen

  1. In NextGen, go to {Base URL}/system-config.

  2. Select the LTI CONFIGURATION tab.

  3. Click Create New LTI Configuration.

    sakai-create-new.png
  4. Complete the LTI configuration form using the values below.

    sakai-form-blank.png

Field

Value / Guidance

LTI Type

Sakai LTI

LTI Course Type

Set as per need:

  • Course and Section: Syncs at both the course and section levels, allowing rosters to be tracked separately for each section within a course.

  • Course Only: Treats the entire LMS course as a single group; section-level distinctions are not considered.

  • Section Only: Provisions users by section only; the parent course is not used as a grouping level.

LTI Base URL

LTI 1.3 Issuer for this Platform from Step 3.
Example: https://qa21-mysql.nightly.sakaiproject.org

Auth Login URL

LTI 1.3 Platform OIDC Authentication URL from Step 3.
Example: https://qa21-mysql.nightly.sakaiproject.org/imsoidc/lti13/oidc_auth

Auth Token URL

LTI 1.3 Platform OAuth2 Bearer Token Retrieval URL from Step 3.
Example: https://qa21-mysql.nightly.sakaiproject.org/imsblis/lti13/token/1

Client ID

LTI 1.3 Client ID from Step 3.
Example: bdf44c9d-8a71-4518-96e6-c6e7030cf314

OIDC Login Redirect

{instanceName}/api/auth/lti/v2/sakai/login
Example: https://migration-test-qa-ng.apporto.com/api/auth/lti/v2/sakai/login

App Identifier

nid
Used for deep linking. See Deep linking to a specific desktop.

Example of a completed Sakai LTI configuration:

sakai-form-filled-1.png
sakai-form-filled-2.png

Caution: Ensure all URLs exactly match the Apporto environment being used. Mismatched URLs are a common cause of launch failure. Do not use localhost.

Step 5: Save the configuration

  1. Click Save Changes.

  2. After successful submission, NextGen redirects to {Base URL}/system-config?tabIndex=5, where the new Sakai configuration is listed.

Expected result: The Sakai LTI configuration is saved and ready to be used from Sakai sites.

Step 6: Launch Apporto from a Sakai site

  1. In Sakai, go to the site from which you want to launch Apporto. Example: Next Gen.

    sakai-course.png
  2. Click the NextGen tool in the site navigation to get the launch link.

  3. This redirects to your Apporto instance and creates the user. You can now launch the desktops assigned to you.

    sakai-launch.png

Expected result: The user is provisioned in Apporto NextGen and can launch their assigned desktops.

Deep linking to a specific desktop

  1. In Administration Workspace > External Tools, click Edit for the tool.

  2. In Custom Parameters (key=value on separate lines), add nid=<desktop id>.

    sakai-app-identifier.png
  3. Save the tool.

Note: nid is the App Identifier configured in Apporto. Ask the Apporto support team for the nid of the desktop you want to deep link to.

Troubleshooting

Launch fails

  • Confirm the Client ID, LTI Base URL, Auth Login URL, and Auth Token URL in Apporto match the values shown in the Sakai tool configuration.

  • Verify the OIDC Login Initiation, Launch, and Keyset URLs registered in Sakai exactly match the Apporto environment.

  • Make sure you are not using localhost.

Course launch does not open Apporto

  • Confirm the tool is available in the Sakai site.

  • Validate that the user has access to an assigned desktop after provisioning.

Deep linking does not open the expected desktop

  • Confirm the App Identifier in Apporto is set to nid.

  • Verify the custom parameter is nid=<desktop id> with the correct desktop ID.