D2L Brightspace Admin Deployment Guide

Before you begin

• Use a Brightspace administrator account that can manage Service Users, OAuth applications, LTI deployments, and Navigation & Themes.
• Have an existing Inkable Docs LTI Advantage registration and deployment. The Admin Center steps below start from Inkable Docs Deployment. If it has not been created, contact support@inkabledocs.com for the LTI registration details before continuing.
• For an initial sandbox deployment, grant access only to the Inkable Docs sandbox course shared with Inkable. Expand course access only when your institution is ready for rollout.

API access and LTI launches are configured separately. The OAuth application enables API calls; the LTI deployment and navbar link let administrators launch the Accessibility Admin Center.

1. Create the Service User

1. Open Admin Tools → Manage Extensibility → Service Users and create a dedicated non-human Service User for Inkable Docs.
2. Open its management page and grant org unit access only to the Inkable Docs sandbox course for this initial deployment. Check descendant access so it does not broaden the intended course access.
3. Configure the permissions below and confirm the Service User is active.

Use this account only for the Inkable integration. See D2L's Service User management instructions for account creation, org unit access, and activation.

2. Configure Service User permissions

On the Service User's management page, open Permissions → Manage. Apply the following permissions at the relevant Course Offering scope. API operations require both OAuth scopes and the corresponding Service User permissions.

Save the permissions. Keep the Service User's org unit access limited to the courses included in your deployment.

3. Register the OAuth 2.0 application

1. Go to Admin Tools → Manage Extensibility → OAuth 2.0 and click Register an app.
2. Set Grant Type to Client Credentials.
3. Set Application Name to Inkable Docs API.
4. Enter the JWKS URL: https://www.inkabledocs.com/api/lti/jwks.
5. Enter the space-separated scopes from the next section in the Scope field.
6. Under Service User, select Add Service User and associate the dedicated Inkable Service User.
7. Complete the remaining fields required by Brightspace, accept the API Developer Agreement, and click Register.

Record the resulting OAuth Client ID for the handoff to Inkable. Follow D2L's OAuth app registration instructions for the complete form.

4. Add the API scopes

Add all 23 scopes below. Paste them into Brightspace's Scope field separated by spaces; each scope is included once.

content:file:read content:file:write content:modules:manage content:modules:readonly content:toc:read content:topics:manage content:topics:readonly managefiles:files:manage managefiles:files:read ltiadvantage:links:read ltiadvantage:links:update ltiadvantage:quicklinks:create ltiadvantage:links:create ltiadvantage:links:delete enrollment:own_enrollment:read dropbox:folders:read dropbox:folders:write quizzing:quizzes:read quizzing:quizzes:write discussions:forums:readonly discussions:topics:readonly discussions:forums:manage discussions:topics:manage

These scopes support reading course modules, topics, and files; creating or updating companion Inkable links and status text; replacing course files when needed; and accessing the assignment, quiz, and discussion content covered by this integration. Service User permissions and course access still control which operations are allowed.

5. Create the Admin Center launch link

Open Admin Tools → External Learning Tools → LTI Advantage and select Inkable Docs Deployment. Scroll to the bottom, click View Links, then select New Link.

Add inkable_launch_mode and d2l_admin_center as the name and value of a single custom parameter. Click Save and Close.

6. Add the link to the navbar

In Navigation & Themes, create the visible navbar link:

1. Select Create Custom Link and name it Accessibility Admin Center.
2. For the URL, choose Insert Quicklink → External Learning Tools → Accessibility Admin Center.
3. Enable Share with child org units.
4. Do not limit the custom link by role.
5. Click Create, include the custom link in the intended navbar, then click Save and Close.

Use the External Learning Tools quicklink so the navbar launches through the LTI deployment. Confirm the saved link appears in the intended navbar.

7. Share configuration details with Inkable

Once configured, share these four values with your Inkable contact or support@inkabledocs.com so the team can complete the connection.

Issuer

Manage Extensibility → LTI Advantage → Brightspace Registration Details → Issuer

Copy the issuer exactly as shown in Brightspace.

Deployment ID

External Learning Tools → LTI Advantage → Deployments → open the Inkable deployment

Use the deployment associated with Inkable Docs.

OAuth Client ID

Manage Extensibility → OAuth 2.0 → open Inkable Docs API

Use the API application's Client ID; the LTI registration has a separate Client ID.

API Base URL

Confirm the host from your institution's Brightspace URL.

Usually the same host as the issuer, for example https://brightspace.example.edu. Use the base URL without a course path.

Verify the deployment

• Confirm the dedicated Service User is active, has the listed permissions, and can access only the intended sandbox course.
• Confirm Inkable Docs API uses Client Credentials, the supplied JWKS URL, all listed scopes, and the correct Service User.
• Launch Accessibility Admin Center from the saved navbar link using an authorized administrator account.
• After the Inkable team completes the connection, verify that the intended sandbox course and its content are available.

If the Service Users tab or Client Credentials option is unavailable, consult your Brightspace administrator and the D2L references below. If the Admin Center launch or course access fails, share the error and the configuration details above with Inkable support.

Official D2L references

• Brightspace OAuth 2.0 authentication guide
• Service Users and server-to-server authentication
• Manage Service Users
• Register an OAuth 2.0 app for server-to-server authentication
• Course content API reference