1. Help Hub
  2. Using PebblePad
  3. LTi with Brightspace

Install LTI with Brightspace

Follow the end-to-end installation guide for the PebblePad LTI with Brightspace for global administrators to integrate the platforms together as recommended.






Installation is not self-serve. To initiate, request support from a PebblePad Integration engineer.



Location server


In all places where indicated within this guide, replace LocationServer with the domain for your geographical area:


Test (all regions)lti1p3.apptest.pebblepad.com
AU Productionlti1p3.pebblepad.com.au
CA Productionlti1p3.pebblepad.ca
UK Productionlti1p3.pebblepad.co.uk
US Productionlti1p3.pebblepad.com






1. Whitelist domain


  1. Log in to your PebblePad with an administrator account.
  2. From the Pebble+ burger menu, choose Additional services > Administration.
  3. Click the Settings tab.
  4. In the General panel, tick Content Security Policy header.
  5. Click Update to save the page.
  6. Return to Content Security Policy header, and add https://s.brightspace.com/
  7. Click Update to save the page.






2. Add external tool


  1. Log in to Brightspace with an administration account.
  2. From the Settings cog, click Manage Extensibility
  3. Click LTI Advantage from the sub menu.
  4. Click Register Tool.
  5. Complete the fields using the information in the table below.
  6. Click Register.


ToolStandard
EnabledOn
NamePebblePad LTI 1.3
Domainhttps://LocationServer
Redirect URLs

https://LocationServer/login/openid/redirect

OpenID Connect Login URL

https://LocationServer/login/openid/authorise

Target Link URI

https://LocationServer/login/openid/redirect

Keyset URL

https://LocationServer/login/OrgURL/.well-known/jwks.json

Extensions✓ Assignment and Grade Services
✓ Deep linking
✓ Names and Role Provisioning Services
Roles✓ Send Institution Role



Your OrgURL is in your PebblePad installation URL, e.g:
  • https://apptest.pebblepad.com/login/abcde






3. Add new deployment


  1. From the modal, click View Deployments
  2. Click New Deployments.
  3. Complete the fields using the information in the table below.
  4. (Optional) Tick Add org units, and choose specific departments, courses or modules.
  5. Click Create Deployment.


ToolPebblePad LTI 1.3
NamePebblePad Assignment
Description(Optional)
Security Settings✓ Org unit information
✓ User information
✓ Link information
✓ Classlist including user not known to this deployment
Configuration Settings
  • ✓ Open as external resource
Custom ParametersName: pebble_username
Value: $User.username






4. Add assignment link


  1. From the modal, click View Links.
  2. Click New link.
  3. Complete the fields using the information in the table below.
  4. Click Save and close.


NamePebblePad Assignment
URL

https://LocationServer/login/openid/redirect

Description(Optional)
TypeBasic Launch






5. Add resource link


  1. Click New Link (again)
  2. Complete the fields using the information in the table below.
  3. Click Save and close.


NamePebblePad Resource Link
URL

https://LocationServer/login/openid/redirect

Description(Optional)
TypeDeep Linking Quicklink






6. Set up config variables


This facilitates the sync of course members from Brightspace to ATLAS with accounts created using Username rather than the OrgDefinedID.


  1. Click the Setting cog, and choose Config Variable Browser.
  2. In the search, paste  d2l.Tools.Classlist.DisplayUsername
  3. Click the link from the results.
  4. Click Add value and choose Select Org Unit.
  5. Choose your org units from the list (local set up specific)
  6. Click Update.
  7. For Value, choose On
  8. Click Save.






7. Create service user account


The API requires authentication from a user account with an administrator role. It is advisable to use a dedicated service account and not a person's actual account.


  1. From the Settings cog, click Roles and Permissions.
  2. Click Create/Copy.
  3. Click Start Fresh.
  4. Name the role PebblePad API Access
  5. In General, tick Cascading Role.
  6. In Course Access Options, tick Access all course groups.
  7. Click Save.
  8. In the Edit Role Interactions, tick every box in the Administrator row in all tables on the page.
  9. Click Save.
  10. From the role's dropdown menu, click Edit Role Permissions.
  11. For each permission below, tick the All column (to enable the whole row).

    Classlist > Has Access To The Classlist
    Grades > See the Grades tool
    Grades > Enter Grades
    Grades > Manage Grades
    Grades > Manage Items and Categories
    Groups and Sections Management > See Groups
    User Information Privacy > See First Names
    User Information Privacy > See Last Names
    User Information Privacy > See Usernames
    User Information Privacy > See Org Defined IDs
    User Information Privacy > See Email Addresses
    Users > View User Enrolments

    Users > <role> (all those you want to be visible to PebblePad)


  12. Click Save and Close.
  13. Create a new Service User Account (opens in new tab) and assign it the PebblePad API Access role.






8. Register API


  1. Log in to Brightspace with the service account.
  2. Click the Settings cog and choose Manage Extensibility.
  3. Click OAuth2.
  4. Click Register an app.
  5. Complete the fields using the information in the table below.
  6. Click Register.
  7. Leave the tab open to retain access to the Client ID and Secret (for next stage)


Application NamePebblePad LTI 1.3
Redirect URL

https://Domain/admin/pebble/Integrations/OAuth2/Authorised

Scopecore:*:* enrollment:orgunit:read grades:gradeobjects:read,write grades:gradevalues:write
Access token lifetime3600 seconds
Description(Optional)
Prompt for user consent✓
Enable refresh tokens✓
Non-commercial Developer Agreement✓


Replace Domain with your location:
  • Test: apptest.pebblepad.com
  • AU Production: v3.pebblepad.com.au
  • CA Production: app.pebblepad.ca
  • UK Production: v3.pebblepad.co.uk
  • US Production: pebblepad.com





9. Set up PebblePad


  1. In a new tab, log in to your PebblePad with an administrator account.
  2. From the Pebble+ burger menu, choose Additional services > Administration.
  3. Click Integrations and Brightspace from the sub menu.
  4. Complete the fields using the information in the table below.
  5. In Settings for SSO, note the Key and Secret
  6. Click Save.
  7. From the Brightspace page, Click Accept.



Brightspace Token URL(Leave as default value)
Client IDCopy from stage 8
Client SecretCopy from stage 8
Brightspace URLYour Brightspace URL - must end with /
Tool ID(Leave as default value)
Brightspace API Version(Leave as default value)






10. Contact PebblePad


For the PebblePad Integration Engineer to authenticate the integration, provide them with:


  • Set-up Stage
  • Brightspace URL
  • ClientID
  • Brightspace Keyset URL
  • Brightspace OAuth2 Access Token URL
  • OpenID Connect Authentication Endpoint
  • Brightspace OAuth2 Audience
  • Issuer
  • DeploymentID



To run an end-to-end user test, follow the workspace manager's guide to creating a Brightspace-linked assignment.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article