Brightspace - Manual Registration¶
Summary¶
To set up LTIAAS with Brightspace you need to:
- Create a new tool in the Brightspace installation
- Register the Brightspace installation inside LTIAAS
- Do a test launch
1) Create a new tool in your Brightspace installation¶
- Login to your Brightspace installation as an administrator.
- Navigate to 'Admin Tools (Gear Icon)' -> 'Manage Extensibility'
- Click the 'LTI Advantage' tab, then the 'Register Tool' button
- In the resulting form. configure the tool with the following information:
- Enabled:
CHECKED
- Name:
Your Tool Name
- Description:
Your Tool Description
- Domain:
https://your.ltiaas.com
- Redirection URLs:
https://your.ltiaas.com
- OpenID Connect Login URL:
https://your.ltiaas.com/login
- Keyset URL:
https://your.ltiaas.com/keys
- Extensions:
CHECKED
<- For each service you plan to use. - Roles:
CHECKED
<- If you plan to use this information in you tool.
- Enabled:
- Click the 'Register' button at the bottom when the form is filled. You can always go back and change this form later if you need to.
- After saving, scroll down to the bottom of the registration page to find the registration details that need to be entered into LTIAAS.
2) Register The Brightspace Installation Inside LTIAAS¶
Follow the steps on the Registering Your First Platform page. Use the table below to help translate the information provided by the LMS to values needed in the LTIAAS registration process.
LTIAAS Registration API Name | Brightspace Provided Name |
---|---|
name | Any name you would like that helps you identify your LMS |
clientId | Client ID |
url | Issuer |
authConfig.method | JWK_SET |
authConfig.key | Brightspace Keyset URL |
accesstokenEndpoint | Brightspace OAuth2 Access Token URL |
authenticationEndpoint | OpenID Connect Authentication Endpoint |
authorizationServer | Brightspace OAuth Audience |
3) Do A Test Launch¶
- In the Brightspace installation, on the page we loft off with when registering the tool, click the 'View Deployments' link near the bottom of the page.
- Click the 'New Deployment' button.
- In the resulting form, enter the following:
- Enabled:
CHECKED
- Tool: Select your tool from the dropdown list
- Name:
Your Tool Name
- Description:
Your Tool Description
- Extensions:
CHECKED
<- For each service you plan to use. - Security Settings:
CHECKED
<- Select as little as possible to avoid passing sensitive user information to your tool.
- Enabled:
- Click the 'Add Org Units' button and in the popup, select which organizations/users should have access to the tool.
- Click the 'Save and Close' button to save the deployment.
- Go back into the the deployment form and click the 'View Links' link at the bottom of the form.
- In the Links page, click the 'New Link' button
- Fill in the resulting form as follows:
- Enabled:
CHECKED
- Name:
Your Tool Name
- URL:
https://your.ltiaas.com
<- Note: if using deep linking but with no content selection screen, you can pass a manually generated deep linking URL here instead. - Description:
Your Tool Description
- Type: Select the way you want the tool to show to the user.
- Enabled:
- Click the 'Save and Close' button.
- Click in the grid icon at the top of the page and navigate to a course, then click the 'Content' tab, and click the 'Add a Module' input box. In the box, give the module a name you prefer.
- Once the module is created, click the 'Existing Activities' button and select 'External Learning Tools' option.
- In the resulting dialog, find your tool name on the list and click it.
- Finally, a link should have been created in the course module page. Click it to launch the tool.