Skip to content

Canvas Documentation #48

@pancakereport

Description

@pancakereport

@cycomachead suggested we put together some documentation for canvas dev work. Some suggestions below are from @timothyaveni

For me, I'm most interested in how this applies to web apps using bCourses auth and user (role) identification, but if anyone else has use cases to highlight, please chime in!

Suggestions:

  • a place to ask for help to become an admin
  • a recommendation, but not a requirement to at UCB the Student ID is the value “SIS User ID” in Canvas
  • Pointers to useful Canvas documentation articles
    • How to add a user
    • SIS Imports CSV
    • Links to promote some as an admin (what's an admin)
  • ~1 paragraph on how OAuth Works or at least a link to a reference
    • Key thing to understand is at Canvas validates the host exactly with what’s in the Developer Key
  • We can reuse / share existing dev keys — so once someone has access to the admin panel (or a working key + secret combo) you don’t really need to create new keys (assuming scopes/redirect URIs are consistent)
  • A recommendation that apps turn on scoped keys even in development.
  • what is a canvas admin and what is it needed for?
  • Not all SIS IDs are 10 digits
  • here's why not to use email addresses as keys

I have admin access to the DATA subaccount so I will also write about my experience getting that and what that allows me to do. One interesting point I should include is about how courses get assigned to subaccounts (and the process of moving them)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions