Brightspace Setup

Introduction

This guide explains how to setup Brightspace for use with Cyclr, as well as how to install a Brightspace Connector.

Setup & Authentication

Remote Setup in Brightspace – performed by Cyclr Partner

Create an app within Brightspace:

• Navigate to your Brightspace instance and login as an Administrator.
• Go to Admin Tools (the “cog” button in the top right), then under the Organization Related section, select Manage Extensibility.
• Select the “OAuth 2.0” area.
• Select the “Register an app” button.
• Create an app:
  • Enter an appropriate name for your app.
  • Set the Redirect URI to the Callback URL of your Cyclr Partner Console.
  • Enter the appropriate scopes for the data you wish to work with in Cyclr.
    • More information on specific scopes can be found here.
    • If you would like to use all of the Methods available on the Cyclr Brightspace Connector, you should set this value to:
      content:*:* core:*:* datahub:*:* enrollment:*:* extended-user-profile:values:manage grades:*:* quizzing:*:* users:*:*.
  • Leave the access token lifetime as the default (3600).
• Read and accept the agreement and select “Register”.
• On the next page you will see the Client ID and Client Secret values of your new app. Make a note of these for use later.

Partner Setup in Cyclr Console

Having created an app within Brightspace to obtain a Client ID and a Client Secret, go into your Cyclr Partner Console:

1. Go to Connectors > Application Connector Library.
2. Use the search box to locate the Brightspace Connector entry.
3. Select the Pencil button.
4. Select the Settings tab.
5. Enter the following values:

Property	Description
Client ID	The Client ID of the Brightspace app.
Client Secret	The Client Secret of the Brightspace app.
Scope	The API scope, outlining which areas Connectors will have access to. More information can be found in the Brightspace documentation.

If you leave these values blank, they must be provided each time the Connector is installed.

Cyclr Connector Installation

When installing a Brightspace Connector, the following values are required:

Property	Description
Domain	If your Brightspace instance is https://teaching.school.edu.uk/, provide a value of only teaching.school.edu.uk
LE API Version	The specific version you would like to use for all LE-based API calls. You should always use the most recent version unless you would like to use a specific version.
LP API Version	As above for LP-based API calls.
BFP API Version	As above for BFP-based API calls.