Register an external learning tool for LTI Advantage

Note: To register a tool, ensure the Manage LTI Advantage Tool Registrations and Manage LTI Advantage Tool Deployments permissions are set at the organization level.

  1. From the Admin Tools menu, click Manage Extensibility.
  2. In the LTI Advantage tab, click Register Tool.
  3. Choose either Dynamic or Standard registration, click Register.
  4. For Standard Registration complete the following fields (* indicates required field):
    • Name*
    • Description
    • Domain*
      Note: Domains can only be used in one enabled registration at a time. If you attempt to register a tool with a domain that is already in use, you will be prompted to disable the existing registration.
    • Redirect URLs*
    • OpenID Connect Login URL*
    • Target Link URI
    • Keyset URL
    • Extensions
  5. For Dynamic Registration complete the following fields:
    • Enter the Dynamic Registration URL provided by the tool. It is optional to allow the tool to also create the deployment with links. Once the Dynamic Registration workflow is complete, the Registration is disabled by default as per the specification. It is recommended to review the Extensions, Parameters, and Security Settings (in the deployment if applicable) that the tool has asked for to ensure they meet your organization's use cases.
      Note: Dynamic registration redirects to the tool’s endpoint in a new tab. This prevents same site and cross site cookie issues.
  6. Under Roles, choose to send IMS role data for the Institution and Context roles or only the Context role. If the Send Institution Role checkbox is checked, Context and Institution roles are included in the role mapping from the IMS configuration when the tool is launched. The user's Context Role is also included unless the security setting at the Deployment is set to Anonymous. If the Send Institution Role checkbox is unchecked, only Context roles are included.
  7. Substitution Parameters: Users can select from a pre-defined list of parameters that is dynamically substituted with a value from the LMS at the time of launch. Brightspace currently supports the following parameters:
  • $

  • $CourseOffering.label

  • $CourseOffering.sourcedId

  • $CourseOffering.title

  • $CourseSection.label

  • $CourseSection.sourcedId

  • $CourseSection.title

  • $CourseSection.timeFrame.begin
  • $CourseSection.timeFrame.end

  • $CourseTemplate.label

  • $CourseTemplate.sourcedId

  • $CourseTemplate.title

  • $Person.address.timezone

  • $

  • $

  • $

  • $

  • $Person.sourcedId

  • $ResourceLink.available.startDateTime

  • $ResourceLink.available.endDateTime

  • $ResourceLink.description

  • $

  • $ResourceLink.submission.endDateTime

  • $ResourceLink.title

  • $

  • $User.username

  1. Customer Parameters: In instances where tools need to define both the name and value of a custom parameter, they can be defined here. These parameters are not dynamically replaced and are constrained to sending a static value for each launch.
    Note: Substitution and Custom parameters created at the Registration level cascade to the Deployment and Link level.
  2. Click Register.