Administration Guide
This article will review the steps for connecting your Brightspace instance to PaperScorer. These are the required steps for connecting your Brightspace instance with PaperScorer.
Setup within your Brightspace Instance
Once you are logged into your admin account, click on the cog wheel within the top navigation next to your user name. When the dropdown navigation is visible, select the Manage Extensibility option within that menu.
After getting to the manage extensibility page, click on the OAuth 2.0 sub-navigation option.
From the OAuth 2.0 management page, you will see a list of registered OAuth 2.0 application. If you have created any application, your list will be empty. We will need to create an OAuth 2.0 connection into the PaperScorer application. Click on the Register an app button to get started adding a new OAuth 2.0 application.
After clicking on the Register an app button, you will be redirected to a form to add details about the new OAuth 2.0 application.
- Application Name (required): This is the name of the OAuth 2.0 application. Recommended value: PaperScorer OAuth Connection
- Redirect URI (required): This is the location a user will be redirected to complete authentication. Required value: https://app.paperscorer.com/brightspace/connect
- Scope (required): This is the permissions that will be granted to the OAuth 2.0 application. Required value: enrollment:orgunit:read grades:gradeobjects:read grades:gradeobjects:write grades:gradevalues:write sections:own_section:read sections:section:read users:profile:read users:own_profile:read users:userdata:read
- Access Token Lifetime (required): This will determine the lifetime of an access token. Recommended value is the default value: 3600
- Description (optional): This field can contain a description of the OAuth 2.0 application. The value can be something to help you define or identify the application.
- Prompt for user consent (required): This will make sure the user is prompted for consent when connecting their account to PaperScorer. This is required to be active.
- Enable refresh tokens (required): This will allow the PaperScorer application to make new access tokens once they expire. This is required to be active.
- Accept the non-commercial development agreement (required): This is a requirement of Brightspace to complete the OAuth 2.0 registration.
Once you are finished filling in all the required information, you can go ahead and click on the Register button. This will save your new OAuth 2.0 application and redirect to a page that contains newly generated keys required to input into PaperScorer.
Back to the PaperScorer app...
When you have the Client ID and Client Secret, you will need to go back to the PaperScorer app to complete the connection. The PaperScorer app is located at https://app.paperscorer.com. You will need to have an account in order to complete the next steps.
NOTE: You will not need a pro account to create/manage connections.
From any page within the PaperScorer app, click on the Connections main navigation option.
Once on the connections page, click on the Add connection button.
After clicking on the add connection button, you will be presented with a add connection modal.
- Type (required): Make sure this is set to Brightspace for the connection type.
- Client domain (required): This value will be set to the instance from the previous steps where you created the OAuth 2.0 application. You will not include 'http://' or 'https://'. However, you will include the sub-domain and the domain when filling this field out. (example: paperscorer.d2l-partners.brightspace.com)
- Client ID (required): Copy and paste the client ID from the newly created OAuth application here.
- Client Secret (required): Copy and paste the client secret from the newly created OAuth application here.
Once the connection is added, you will need to complete two more steps to finalize the connection.
- Activate the connection: The connection will need to be toggled to the active state. At any point in the future, you can toggle this to off to disconnect all your Brightspace users.
- Verify the connection: This will verify that you have the correct access to add and claim this connection. It will send you through a simple log in process/auth process through your instance. It is not saving any session information, but simply checking for a valid auth session passed back from your instance.
After you have completed the above two steps, your users will be able to connect their accounts to pass data back and forth between PaperScorer and their Brightspace account.
Your users should be able to create an account at this point and connect it back to PaperScorer. Your users can following this help documentation explaining the process: https://help.paperscorer.com/article/204-connect-your-account-to-brightspace