Skip to content

LTI 1.3 Parameters Required for Hypothesis LMS App Integration

Jump to bottom
mattdricker edited this page Jul 28, 2022 · 2 revisions

LTI 1.3 Parameters for Hypothesis Application Integration

The Hypothesis LMS application requires a number of LTI 1.3 parameters to be available in launch requests. See IMS's LTI core specification for further information about these LTI-standard parameters.

Required LTI Parameters

Authentication

The authentication of an LTI 1.3 launch uses OpenID Connect Core to authenticate with hypothesis. This authentication relies on the previous exchange of various identifiers (client_id, deployment_id) as well as public key encryption to sign the messages.

Other required parameters

  • sub: This instance-unique, opaque user identifier is used to generate a deterministic Hypothesis username for each LMS user.
  • given_name, family_name, name: Used to generate human-readable display names for Hypothesis LMS users.

Parameters from the LTI claim

These parameters all name spaced under https://purl.imsglobal.org/spec/lti/claim

  • roles: This parameter is used to identify Instructor and Administrator users, who are able to create course-wide groups to hold annotations.
  • context/title: This parameter is used to generate the appropriate name for course-wide groups (which hold the course's annotations).
  • context/id: Unique ID for the current course; used to identify application resources related to the current course.
  • version, message_type: These LTI parameters are required for all LTI requests (not specific to Hypothesis integration).
  • resource_link/id: This parameter uniquely identifies an assignment. For more information on how our app uses resource_link_id, see this document.
  • resource_link/description: Description of the assignment in the LMS. Optional.
  • tool_platform/guid: This parameter identifies the LMS instance (e.g. institution) making the request and is needed to differentiate users between LMS instances and correctly associate course groups with their LMS instance.

Parameters required for grading support

These parameters are under the https://purl.imsglobal.org/spec/lti-ags/claim/endpoint claim.

  • endpoint/lineitem: Location (URL) of service to which grades can be submitted.

Parameters required for Deep Linking.

Only on supported LMSs. Under the https://purl.imsglobal.org/spec/lti-dl claim.

  • deep_linking_settings/deep_link_return_url URL where deeplinking request are returned.

Optional LTI Substitution Variables

  • ResourceLink.title
    • to show the title of the assignment in app
    • human readable reporting on assignments
  • ResourceLink.description
    • to show assignment instructions in app
    • human-readable reporting
  • ResourceLink.available.startDateTime
    • to notify students when their assignment is available
    • reporting: identify "planned" assignments which indicates "embedded" use, a KPI
  • ResourceLink.submission.endDateTime
    • automatically submit for students
    • report on completion rates
  • ResourceLink.id.history
    • facilitate more reliable course copy
  • Context.id.history
    • facilitate more reliable course copy

Unused LTI Parameters

There are a few common LTI parameters that the Hypothesis application does not need currently. It is possible some of these could be needed in the future.

  • email
  • Any parameter in with tool_platform except guid
Clone this wiki locally