-
Notifications
You must be signed in to change notification settings - Fork 78
feat: document how to share pii to lti components #1368
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
sarina
merged 2 commits into
openedx:main
from
open-craft:samuel/document-sharing-pii-lti
Jan 8, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions
41
.../educators/references/course_development/exercise_tools/allow_lti_share_pii.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| .. _Allow sharing PII to LTI Components: | ||
|
|
||
| Allow sharing PII to LTI Components | ||
| ################################### | ||
|
|
||
| .. tags:: site operator, how-to | ||
|
|
||
| The LTI component block has settings to share the user's email or username with the LTI application. | ||
| By default, these settings are disabled for privacy reasons. | ||
| The settings may be enabled per-course by an administrator, using the Django admin console: | ||
|
|
||
| #. With a system administrator account, navigate to the django admin console, and find the "Course allow pii sharing in lti flags" item. | ||
| Click the text on the left for the item to navigate to the page with the list of these flags. | ||
| From this page, you can add, modify, or delete flags. | ||
|
|
||
| .. image:: /_images/site_ops_how_tos/lti_pii_sharing_admin_1.png | ||
| :alt: A screenshot of the Django admin console showing the "Course allow pii sharing in lti flags" menu item. | ||
|
|
||
| #. Click the button to add a new flag: | ||
|
|
||
| .. image:: /_images/site_ops_how_tos/lti_pii_sharing_admin_2.png | ||
| :alt: A screenshot of the Django admin console showing the button to "add course allow pii sharing in lti flag". | ||
|
|
||
| #. In the new flag form, enter the ID for the course you wish to enable this for, and ensure the "Enabled" field is checked. | ||
|
|
||
| .. image:: /_images/site_ops_how_tos/lti_pii_sharing_admin_3.png | ||
| :alt: A screenshot of the Django admin console showing the form to add an enabled flag for a particular course id. | ||
|
|
||
| #. Finally, save the form. | ||
|
|
||
| .. seealso:: | ||
|
|
||
| :ref:`LTI Component settings` (reference) | ||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | | | | | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -171,10 +171,9 @@ LTI Component Settings | |
| launches, the learners are warned that if they continue, their email | ||
| address will be shared with the LTI provider. | ||
|
|
||
|
|
||
| By default, this setting is not available in Studio. | ||
| To make this setting available, a system administrator must enable the | ||
| setting in the Django administration console. | ||
| See :ref:`Allow sharing PII to LTI Components` for how to enable | ||
| (requires system administrator privileges). | ||
|
|
||
| * - Request user's username | ||
| - Sends the learner's username to the remote LTI tool. This is the | ||
|
|
@@ -186,9 +185,8 @@ LTI Component Settings | |
| will be shared with the LTI provider. | ||
|
|
||
| By default, this setting is not available in Studio. | ||
|
|
||
| To make this setting available in Studio, a system administrator must | ||
| enable the setting in the Django administration console. | ||
| See :ref:`Allow sharing PII to LTI Components` for how to enable | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add this ref to the seealso table as well?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done, thanks! :) |
||
| (requires system administrator privileges). | ||
|
|
||
| .. seealso:: | ||
|
|
||
|
|
@@ -202,6 +200,7 @@ LTI Component Settings | |
|
|
||
| :ref:`Enabling and using LTI Advantage features` (how-to) | ||
|
|
||
| :ref:`Allow sharing PII to LTI Components` (how-to) | ||
|
|
||
| **Maintenance chart** | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please add a maintenance table to this document?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, thank for your review! :)