Skip to main content

Canvas Admin Setup: OAuth2 App Configuration for Fishtank Student

Fishtank Student Support
Updated

This article provides step-by-step instructions for Canvas administrators to create and configure a Developer Key for Fishtank Student Integration, including required OAuth scopes, redirect URIs, and credential sharing, with important notes on exact URI matching, key activation, and the one-time visibility of the Client Secret.

1. Log in to Canvas as an administrator

Note: Before Fishtank Student can integrate with Canvas, a Canvas Administrator with access to manage Developer Keys needs to create and configure an OAuth2 Developer Key for their district. 

2. Navigate to Developer Keys

Account → Developer Keys (or Admin → Developer Keys, depending on your Canvas instance)

3. Create a New Developer Key

  • Click + Developer Key or + Create Developer Key

  • Select OAuth 2.0 or API Key as the key type

4. Configure the Developer Key

Key Name: Fishtank Student Integration
Owner Email: Your contact email

Redirect URI(s):

  • Production: https://student.fishtanklearning.org/canvas/oauth2-callback/

  • Staging/Testing: https://student.local.org/canvas/oauth2-callback/ (or your staging URL)

Required Scopes:

  • url:GET|/api/v1/users/self – Read user information

  • url:GET|/api/v1/courses – Read courses

  • url:GET|/api/v1/courses/:course_id/students – Read course students

  • url:POST|/api/v1/courses/:course_id/assignments – Create assignments

  • url:PUT|/api/v1/courses/:course_id/assignments/:id – Update assignments

  • url:POST|/api/v1/courses/:course_id/assignments/:id/submissions – Create/update submissions

  • url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id – Grade submissions

5. Save the Developer Key

6. Copy Credentials

After saving, Canvas will display:

  • Client ID

  • Client Secret

7. Email Fishtank Staff

Please provide the Client ID and Client Secret to Fishtank staff for configuration by emailing support@fishtanklearning.org.

 

Important Notes

  • The Redirect URI must match exactly, including the trailing slash

  • The Developer Key must be Active

  • The Client Secret cannot be retrieved after initial creation

Powered by Zendesk