The checkbox fields on the Tool Consumer screen determine if specific Security Settings appear when a user creates or edits an External Learning Tool link. Each security setting is responsible for sending specific context data at the time of launch.
- Allow sending tool consumer information to tool provider determines if the tool_consumer variables are allowed to be included in an LTI launch.
- Allow sending context information to tool provider determines if context variables are included in the LTI launch. This specifically effects the context_id, context_title, context_label, and context_type variables.
- Allow sending course information to tool provider determines if course context information can be included in the launch. These are lis_course_offering_sourcedid and lis_course_section_sourcedid. Note: section will be the same value as lis_course_offering_sourcedid.
- Allow sending User ID to the tool provider determines if the current user's obfuscated user_id value is included in the LTI launch. If the User_Id is included, Brightspace generates a unique guid value which is sent as the user_id. This guid value is consistent for every launch performed by a specific user, but provides no means for an external party to determine who the user.
- Allow sending user name to tool provider determines if the user's name values are allowed within an LTI post. These values are populated with the user's First Name and Last Name as entered in their Brightspace User profile.
- Allow sending user email to tool provider determines if the email field is available to be included in the LTI launch. This value is populated from the email property of the current user's email property.
- Allow sending system username to tool provider determines if the username field is available to be included in the LTI launch.
- Allow sending system Org Defined ID to tool provider determines if the OrgDefinedId field is available to be included in the LTI launch.This field is not a standard LTI field. It is populated with the current user's OrgDefinedId property.
- Allow sending system role to tool provider determines if the custom D2L role field is available to be included in the LTI launch. This is not a standard LTI role field. It is populated with the name of the Role the user has within the context of the org unit from which the LTI launch occurs. This is different from the standard roles field which always contain a valid LTI role value.
- Allow sending link title to tool provider determines if the name of the External Learning Tool Link is included in the LTI launch.
- Allow sending link description to tool provider determines if the description within the External Learning Tool Link is included in the LTI launch.
- Allow sending section code to tool provider determines if course section code can be included in the launch. This is the lis_course_section_sourcedid. Note: if not checked, but Allow sending Course Information is allowed then the section is sent with the same value as lis_course_offering_sourcedid. When the setting is checked, any launch that is associated with that link/tool acts in the following way:
- If no sections exist:
send lis_course_section_sourcedid = lis_course_offering_sourcedid
If one section exists:- check user enrollment
if enrolled in section
send lis_course_section_sourcedid = section course offering code
if not enrolled in section
send lis_course_section_sourcedid = lis_course_offering_sourcedi
- If more than one section exists:
- check user enrollment
if enrolled in one section
send lis_course_section_sourcedid = section course offering code
- if not enrolled in any section
send lis_course_section_sourcedid = lis_course_offering_sourcedid
if enrolled in multiple sections
send lis_course_section_sourcedid = section course offering code for first enrollment-
based on section name - alphabetical
To understand what data Brightspace sends, use the map below:
UI Control Name
POS |
POST Form Parameter
|
Sample Value
|
Description |
|---|
Send tool consumer information to tool provider
|
tool_consumer_instance_guid |
secret |
The key value set at the org tool consumer information page.
|
Send tool consumer information to tool provider
|
tool_consumer_instance_name |
Partners |
The name value set at the org tool consumer information page.
|
Send tool consumer information to tool provider
|
tool_consumer_instance_description
|
Global tools description
|
Description value entered at the org tool consumer information page.
|
Send tool consumer information to tool provider
|
tool_consumer_instance_contact_email |
admincontact@ educationtest.com
|
The email address value entered at the org tool consumer information page.
|
Send tool consumer information to tool provider
|
tool_consumer_info_version
|
10.8.3.0
|
The version number of the Brightspace platform.
|
Send tool consumer information to tool provider
|
tool_consumer_info_product_family_code
|
desire2learn |
The product code or reference to Brightspace, that identifies the platform to the tool provider.
|
Send context information to tool provider
|
context_id |
8631 |
The ID of the org unit the launch comes. Typically, this is the course ID but you may also use template, section, or group.
|
| Send context information to tool provider |
context_label
|
Math 101 |
Code of the org unit the launch comes from. Typically, this is the course code.
|
Send context information to tool provider
|
context_title |
Math 101
|
Title of the org unit the launch comes from. Typically, this is the course title.
|
Send context information to tool provider
|
context_type
|
CourseOffering
|
The org unit type name for the launch. Typically, this would read "CourseOffering" to denote a course.
|
Send course information to tool provider
|
lis_course_offering_sourcedid |
partners.brightspace.com:math101 |
Contains the LIS course identifier with this launch.
|
Send course information to tool provider
|
lis_course_section_sourcedid
|
partners.brightspace.com:math101 |
Contains the LIS course offering identifier with this launch. An option is available to send the Course Section Code for 1.1 launches.
|
Send LTI user ID and LTI role list to tool provider
|
user_id
|
ca5578d1-ee6a-434a-840d-405d7cc0b9b7_168
|
An opaque (format subject to change) unique identifier for the context.
|
Send LTI user ID and LTI role list to tool provider
|
roles |
urn:lti:instrole:ims/lis/Instructor
|
A list of roles that user is mapped to. This relates to the IMS Role Mapping tool inside of Brightspace (allowing one-to-many role mappings).
|
Send user name to tool provider
|
lis_person_name_given
|
John
|
The first name of the activating user.
|
| Send user name to tool provider |
lis_person_name_family
|
Snivy
|
Last name of the activating user.
|
Send user name to tool provider
|
lis_person_name_full |
John Snivy
|
The full name of the activating user.
|
Send user email to tool provider
|
lis_person_contact_email_primary |
john.snivy@educationtest.com |
The email for the activating user.
|
Send system username to tool provider
|
ext_d2l_username |
John.Snivy
|
Sends over the username of the user. This is different from the user's name (first and last).
|
Send system Org Defined ID to tool provider
|
ext_d2l_orgdefinedid
|
1089679 |
Org-defined ID is a field specific to Brightspace, so this does not come up in the IMS spec. This is typically a unique identifier for the user, specified by the tool consumer. Enabling this sends over the user's org-defined ID in the filed.
|
Send system role to tool provider
|
ext_d2l_role |
Section Instructor
|
Unlike the roles field previous, this one sends over the Brightspace role name. This only includes one role and does not match the IMS supported roles as it is their specific role inside the LMS.
|
Send link title to tool provider
|
resource_link_title |
Week 1 Math Assignment
|
Sends the name and title of the LTI link as it exists inside the LMS. This may change over the lifetime of the link.
|
Send link description to tool provider
|
resource_link_description |
Admin LTI link used for troubleshooting
|
If a description has been provided to the LTI link, it appears here.
|
Sample Request for 1.0 Launch
Here is an example of a legacy LTI request coming from Brightspace can look like, with all the security settings enabled:
<html>
<body>
<div id="ltiLaunchFormSubmitArea">
<form method="post" id="LtiRequestForm" name="LtiRequestForm" action="http://ltiapps.net/test/tp.php"" enctype="application/x-www-form-urlencoded">
<input type="hidden" name="custom_userid" value="169">
<input type="hidden" name="lis_result_sourcedid" value="a573f15a-cec3-418f-ab3c-1f36e7d87430">
<input type="hidden" name="ext_d2l_token_id" value="5306288">
<input type="hidden" name="ext_d2l_link_id" value="144437">
<input type="hidden" name="ext_d2l_token_digest" value="ajBeRQMIratFlRyB8mTL8vnsQxU=">
<input type="hidden" name="ext_completion_url" value="">
<input type="hidden" name="launch_presentation_locale" value="EN-US">
<input type="hidden" name="tool_consumer_instance_guid" value="secret">
<input type="hidden" name="tool_consumer_instance_name" value="Partners">
<input type="hidden" name="tool_consumer_instance_description" value="admincontact@educationtest.com">
<input type="hidden" name="tool_consumer_instance_contact_email" value="">
<input type="hidden" name="tool_consumer_info_version" value="10.8.3.0">
<input type="hidden" name="tool_consumer_info_product_family_code" value="desire2learn">
<input type="hidden" name="context_id" value="8631">
<input type="hidden" name="context_title" value="Math 101">
<input type="hidden" name="context_label" value="Math 101">
<input type="hidden" name="context_type" value="CourseOffering">
<input type="hidden" name="user_id" value="ca5578d1-ee6a-434a-840d-405d7cc0b9b7_111">
<input type="hidden" name="roles" value="urn:lti:instrole:ims/lis/Instructor">
<input type="hidden" name="lis_person_name_given" value="John">
<input type="hidden" name="lis_person_name_family" value="Snivy">
<input type="hidden" name="lis_person_name_full" value="John Snivy">
<input type="hidden" name="lis_person_contact_email_primary" value="john.snivy@educationtest.com">
<input type="hidden" name="ext_d2l_username" value="John.Snivy">
<input type="hidden" name="ext_d2l_orgdefinedid" value="">
<input type="hidden" name="ext_d2l_role" value="Section Instructor">
<input type="hidden" name="ext_d2l_tenantid" value="41b632b6-ff74-4288-b3f1-7ffb6eb14bb4">
<input type="hidden" name="ext_tc_profile_url" value="https://partners.brightspace.com/d2l/api/ext/1.0/lti/tcservices">;
<input type="hidden" name="resource_link_title" value="Week 1 Math Assignment">
<input type="hidden" name="resource_link_id" value="">
<input type="hidden" name="resource_link_description" value="">
<input type="hidden" name="lis_outcome_service_url" value="https://partners.brightspace.com/d2l/le/lti/Outcome">;
<input type="hidden" name="lti_version" value="LTI-1p0">
<input type="hidden" name="lti_message_type" value="basic-lti-launch-request">
<input type="hidden" name="lis_course_offering_sourcedid" value="partners.brightspace.com:Jordan Snider Course 2">
<input type="hidden" name="lis_course_section_sourcedid" value="partners.brightspace.com:Jordan Snider Course 2">
<input type="hidden" name="oauth_version" value="1.0">
<input type="hidden" name="oauth_nonce" value="3bff529f-d941-424a-bb35-aa3e97a4c3b2">
<input type="hidden" name="oauth_timestamp" value="1513353415">
<input type="hidden" name="oauth_signature_method" value="HMAC-SHA1">
<input type="hidden" name="oauth_consumer_key" value="secret">
<input type="hidden" name="oauth_callback" value="about:blank">
<input type="hidden" name="oauth_signature" value="wyWXmyxWC/aegAd2PQ145l3t8Fs=">
<input type="submit" name="ext_basiclti_submit" value="Launch Endpoint with BasicLTI Data">
</form>