Skip to main content

Setting Up LTI 1.3 for Brightspace (D2L)

A step-by-step walkthrough for connecting Brightspace (D2L) to Vocareum using the Manage Extensibility tool registration flow.

J
Written by Julia Dashzeveg

For Admins

This guide describes how to set up a Learning Tools Interoperability (LTI) 1.3 connection between Brightspace (D2L) and Vocareum. The setup registers Vocareum as an LTI 1.3 tool in Brightspace, creates a deployment, adds two deep-linking placement links, and then records the resulting Client ID and Deployment ID in Vocareum at the organization level. The steps below are a one-time, root-level setup that must be in place before any individual Brightspace course can connect to Vocareum.

If the Brightspace-to-Vocareum integration is already installed and you only need to enable LTI within an existing Vocareum course, refer to Configure LTI 1.3 in Your Course instead.

Prerequisites

Before beginning, confirm that you have the access listed below.

  • Brightspace Admin access with permissions to manage extensibility, register LTI 1.3 tools, create deployments, and create links. If you do not have these permissions, contact your institution administrator to complete the setup.

  • Vocareum Organization Admin (Org Admin) access.

Registering Vocareum as an LTI 1.3 tool

The Brightspace tool registration form supplies Vocareum with the endpoints and extensions it requires to accept incoming launches. Complete the steps below from the Brightspace Admin area.

  1. In Brightspace, click the gear icon in the top navigation, then choose Manage Extensibility.

  2. Open the LTI Advantage tab and click Register Tool.

  3. Select Standard Registration. The tool registration form opens.

The next steps fill in the registration form with Vocareum's endpoints.

  1. In Name, enter a descriptive label for the tool, for example Vocareum LTI 1.3.

  2. In Description, enter an optional description.

  3. In Domain, enter the Vocareum domain:

    https://labs.vocareum.com

  4. In Redirect URLs, enter the Vocareum launch URL:

    https://labs.vocareum.com/lti/launch.php

  5. In OpenID Connect Login URL, enter the Vocareum OIDC login URL:

    https://labs.vocareum.com/lti/oidc_login.php

  6. In Target Link URI, enter the Vocareum launch URL:

    https://labs.vocareum.com/lti/launch.php

  7. In Keyset URL, enter the Vocareum public keyset URL:

    https://labs.vocareum.com/lti1.3/jwks.json

The next steps enable the LTI extensions and role setting that Vocareum requires.

  1. Under Extensions, enable Assignment and Grade Services, Deep Linking, and Names and Role Provisioning Services.

  2. Enable Send Institution Role.

  3. Click Register. Brightspace displays a tool registration details panel containing the values Vocareum will need to complete the connection, including the Client ID, Brightspace Keyset URL, OpenID Connect Auth Endpoint, Brightspace OAuth2 Access Token URL, and Brightspace OAuth2 Audience. Keep this panel open for the remaining sections.

Creating a deployment

A deployment attaches the registered tool to one or more Brightspace Org Units and produces the Deployment ID that Vocareum will pair with the Client ID.

  1. From the tool registration details panel, click View Deployments, then click New Deployment.

  2. In the Tool dropdown, select the Vocareum tool you just registered.

  3. In Name, enter a descriptive label for the deployment, for example Vocareum LTI 1.3 Deployment.

  4. In Description, enter an optional description.

  5. Under Extensions and Security Settings, enable the settings shown below.

    Brightspace deployment Extensions and Security Settings panel, with Assignment and Grade Services, Deep Linking, and Names and Role Provisioning Services checked under Extensions; and under Security Settings, Org Unit Information and User Information (including Name, Email, User ID, Username, and Org Defined Id) and Link Information checked, with Anonymous, Classlist including users not known to this deployment, and Open as External Resource left unchecked.

  6. Under Org Units, select the Org Units that the tool will be made available to.

  7. Click Create Deployment. Brightspace displays a Deployment Details panel that includes the Deployment ID.

Creating deep-linking placement links

Two placement links determine where instructors can add Vocareum content inside a Brightspace course. Create both links so that instructors have access to the embedded content workflow and the graded activity workflow.

  1. From the Deployment Details panel, click View Links, then click New Link.

  2. Create the first link as the Deep Linking Insert Stuff placement:

    • Name: a descriptive label, for example Vocareum (Insert Stuff).

    • Type: Deep Linking Insert Stuff.

    • URL: https://labs.vocareum.com/lti/launch.php

  3. Save the link, then return to the deployment's Links page and click New Link again.

  4. Create the second link as the Deep Linking QuickLink placement:

    • Name: a descriptive label, for example Vocareum (QuickLink).

    • Type: Deep Linking QuickLink.

    • URL: https://labs.vocareum.com/lti/launch.php

Copying the Client ID and Deployment ID

The next section registers Vocareum's connection back to Brightspace using two identifiers that Brightspace generated during the previous steps: the Client ID from the tool registration details panel, and the Deployment ID from the Deployment Details panel.

  1. Return to the tool registration details panel from the Registering Vocareum as an LTI 1.3 tool section and copy the Client ID value. Store it somewhere you can paste from later, along with the Brightspace Keyset URL, OpenID Connect Auth Endpoint, Brightspace OAuth2 Access Token URL, and Brightspace OAuth2 Audience values from the same panel.

  2. Return to the Deployment Details panel from the Creating a deployment section and copy the Deployment ID value. Store it alongside the Client ID.

Registering the issuer and deployment in Vocareum

With the Client ID and Deployment ID copied, register Brightspace as an LTI 1.3 issuer in Vocareum at the organization level. For the step-by-step procedure and the exact Brightspace values to enter, refer to Registering an LTI 1.3 Issuer and Deployment in Vocareum.

Next steps

With the root-level integration in place, instructors can now add Vocareum to individual Brightspace courses using the Insert Stuff or QuickLink placements and optionally map assignments for grade passback.

Did this answer your question?