Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-75279

LTI NRPS response omits username property

    XMLWordPrintable

Details

    • MOODLE_311_STABLE, MOODLE_39_STABLE, MOODLE_400_STABLE, MOODLE_401_STABLE
    • MOODLE_400_STABLE, MOODLE_401_STABLE
    • MDL-75279-401
    • Hide

      Prerequisites

      1. Ensure your site is available on a publicly accessible URL (use ngrok if testing locally)

      Testing

      1. Log in as admin
      2. Navigate to Plugins > Activity modules > External tool > Manage tools in site administration
      3. Press Configure a tool manually
      4. Create an LTI 1.1 external tool at the system admin level with the following values:
        • URL of https://saltire.lti.app/tool
        • consumer key of "moodle" (value does not actually matter)
        • shared secret of "secret"
        • set "Default launch container" to "New window" (optional)
        • select the "IMS LTI Names and Role Provisioning" service (set to "User this service to retrieve members' information as per privacy settings"_
        • set "Share launcher's name with tool" to "Always"
      5. Create a user
      6. Create a course
      7. Enrol user in course as a student
      8. Add an instance of the new external tool to the course
      9. View the external tool activity you created
      10. From the "Service" dropdown menu select "Names and Role Provisioning": the service endpoint should be populated and the format set to "application/vnd.ims.lti-nrps.v2.membershipcontainer+json"
      11. Click on the "Read" button
      12. Click "Yes" when prompted to "View request message?"
      13. Click on the "Formatted response body" tab
      14. Confirm that the "members" array now contains the ext_user_username for each member
      Show
      Prerequisites Ensure your site is available on a publicly accessible URL (use ngrok if testing locally) Testing Log in as admin Navigate to Plugins > Activity modules > External tool > Manage tools in site administration Press Configure a tool manually Create an LTI 1.1 external tool at the system admin level with the following values: URL of https://saltire.lti.app/tool consumer key of "moodle" (value does not actually matter) shared secret of "secret" set "Default launch container" to "New window" (optional) select the "IMS LTI Names and Role Provisioning" service (set to "User this service to retrieve members' information as per privacy settings"_ set "Share launcher's name with tool" to "Always" Create a user Create a course Enrol user in course as a student Add an instance of the new external tool to the course View the external tool activity you created From the "Service" dropdown menu select "Names and Role Provisioning": the service endpoint should be populated and the format set to "application/vnd.ims.lti-nrps.v2.membershipcontainer+json" Click on the "Read" button Click "Yes" when prompted to "View request message?" Click on the "Formatted response body" tab Confirm that the "members" array now contains the ext_user_username for each member

    Description

      The original Memberships service includes the username property for each user in its response, but the later Context Memberships service from the NRPS spec does not.  This makes it problematic for tool which are updating to use the newer service.  The username should be included in all versions of the service, provided the privacy setting allows it (in the same way that the username is included in a launch message).

      Attachments

        1. 400.png
          400.png
          101 kB
        2. 401.png
          401.png
          110 kB
        3. Master.gif
          Master.gif
          744 kB

        Activity

          People

            svickers Stephen Vickers
            svickers Stephen Vickers
            Heinrich Fenkart Heinrich Fenkart
            Paul Holden Paul Holden
            Ron Carl Alfon Yu Ron Carl Alfon Yu
            Votes:
            4 Vote for this issue
            Watchers:
            9 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - 0 minutes
                0m
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 2 hours, 36 minutes
                2h 36m

                Clockify

                  Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.