-
Notifications
You must be signed in to change notification settings - Fork 14
LTI Parameters Required for Hypothesis LMS App Integration
Lyza Gardner edited this page Jan 21, 2021
·
11 revisions
The Hypothesis LMS application requires a number of LTI parameters to be available in launch requests. See EduAppCenter's LTI POST parameter documentation for further information about these LTI-standard parameters.
These are used to verify the launch request:
-
oauth_consumer_key
,oauth_shared_secret
,oauth_signature_method
,oauth_timestamp
,oauth_nonce
,oauth_version
,oauth_signature
.
-
lti_message_type
,lti_version
,resource_link_id
: These LTI parameters are required for all LTI requests (not specific to Hypothesis integration). For more information on how our app usesresource_link_id
, see this document. -
tool_consumer_instance_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. -
user_id
: This instance-unique, opaque user identifier is used to generate a deterministic Hypothesis username for each LMS user. -
roles
: This parameter is used to identifyInstructor
andAdministrator
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 -
launch_presentation_return_url
: This URL helps the application know where to return the user after completing an action -
lis_person_name_full
,lis_person_name_given
,lis_person_name_family
: Used to generate human-readable display names for Hypothesis LMS users.
-
lis_outcome_service_url
: Location (URL) of service to which grades can be submitted -
lis_result_sourcedid
: Opaque identifier provided by the LMS to identify a submission
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.
lis_person_contact_email_primary
context_type
context_label
- Any parameter beginning with
launch_presentation_
, exceptlaunch_presentation_return_url
- Any parameter beginning with
tool_consumer_instance_
excepttool_consumer_instance_guid
- Any parameter beginning with
tool_consumer_info_