LTI 1.3

Carnap supports LTI 1.3 for login.¹ This allows Carnap to be launched directly from a Learning Management System, and to hand over management of user account data (like email, name, and student ID) as well as login, to the LMS.

Various major LMS implementations including Moodle, Brightspace, and Canvas support LTI 1.3 natively.

Basic Setup Outline

Connecting Carnap to your university's LMS involves three steps.

1. Your LMS needs to be configured to recognize Carnap
2. Your Carnap server needs to be configured to recognize your LMS
3. Your Carnap class needs to be configured to auto-enroll students who are launching Carnap from within your LMS.

Below, you'll find sections on each of these steps.

Step 1 - Configuring your LMS to recognize Carnap

There are a few generic pieces of information your LMS will need in order to connect to Carnap. These are as follows:

• oidc_initiation_url: https://carnap.io/auth/page/lti13/initiate
• target_link_uri: https://carnap.io
• Public JWK URL: https://carnap.io/auth/page/lti13/jwks
• Redirect URLs: https://carnap.io/auth/page/lti13/authenticate

If you are running your own instance of the Carnap server, you will use the same paths but with your custom domain name replacing "carnap.io".

However, different LMSes need this information to be entered in different places. This will generally be the responsibility of an LMS administrator, rather than the responsibility of an individual instructor, so you may need to work with your IT department to arrange the initial setup of the LMS integration.

Now - here are instructions on configuring your LMS, for the LMSes we have experience with. If something is missing or incorrect, please consider opening an issue here or sending an email to gleachkr@ksu.edu.

{
   "title": "Carnap",
   "description": "Carnap Logic Framework",
   "oidc_initiation_url": "https://carnap.io/auth/page/lti13/initiate",
   "target_link_uri": "https://carnap.io/",
   "public_jwk_url": "https://carnap.io/auth/page/lti13/jwks",
   "scopes": [
      "https://purl.imsglobal.org/spec/lti-ags/scope/lineitem",
      "https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly",
      "https://purl.imsglobal.org/spec/lti-ags/scope/score",
      "https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly"
   ],
   "extensions": [
      {
         "domain": "carnap.io",
         "tool_id": "Carnap.io",
         "platform": "canvas.instructure.com",
         "settings": {
            "text": "Carnap",
            "selection_height": 800,
            "selection_width": 800,
            "privacy_level": "public",
            "placements": [
               {
                  "text": "Carnap",
                  "enabled": true,
                  "placement": "course_navigation",
                  "message_type": "LtiResourceLinkRequest",
                  "target_link_uri": "https://carnap.io/",
                  "windowTarget": "_blank"
               }
            ]
         }
      }
   ]
}

Step 2 - Configuring Carnap to recognize your LMS

After your LMS is configured to talk to Carnap, it needs to be registered on the Carnap server. For setup with the public Carnap instance at Carnap.io, contact Graham with the following details from your LMS:

• Public JWKs URL
• Authorization Redirect URL
• Client ID

For example, for a cloud Canvas (production environment), these would be:

• JWK URL: https://canvas.instructure.com/api/lti/security/jwks
• Authorization redirect URL: https://canvas.instructure.com/api/lti/authorize_redirect
• Client ID: from your LTI developer key
• Deployment ID: not required for Carnap

If you are running a self-hosted instance of Carnap, you can configure LTI Platforms (Learning Management Systems) on the admin page at https://carnap.example.com/master_admin.

Step 3 - Configuring your Carnap class for auto-enrollment

Automatic registration links a class on the Carnap server to a class in an LMS, and automatically registers students in the Carnap class when they log in to Carnap from the associated course in the LMS LMS.

Once you've completed steps 1 and 2 above, attempt to log in to Carnap from the LMS course that you want to connect to Carnap. A message will appear on the Carnap user registration page giving you an autoregistration ID. The ID will look something like this:

{"ltiDeploymentId":"…", "ltiContextId":"…","ltiIssuer":"…","label":"…"}

but with concrete values replacing the ellipses.

Copy this ID down (the whole thing, including the enclosing brackets) and go to your instructor page on Carnap. Select the course that you wish to associate with your LMS course, and edit the course information. In the course information, there will be a field where you can paste the autoregistration ID.

Once that ID has been configured, all future launches from your LMS course will be registered in the associated Carnap course automatically.

Notes

• Automatic registrations are allowed even if your course is closed (even if you've unchecked the "course open" box on your instructor page). So, you can set registration to be LTI only simply by setting your course to be closed.

• Students will have their user information automatically synchronized with the LMS on every launch, so if they want to change their name or other details, that should be accomplished in the LMS or other upstream systems.