6 .Nd Interact with Canvas installations
10 suite allows interaction with Canvas installations.
14 programs need to know the url of the Canvas installation they will
15 connect to, and authentication to perform actions as the proper
16 user. For this, two files are used.
19 .It ${XDG_CONFIG_HOME}/nci/site
20 This text file should contain exactly one line, which will be treated
21 as a base url. This should be something like
23 .Dl https://someuniversity.instructure.com
24 .It ${XDG_CONFIG_HOME}/nci/token
25 This text file should contain exactly one line, which will be read as
26 an access token. For details, see
34 authenticate themselves to Canvas by means of
36 The standard way for an application to acquire an access token is to
37 register with Instructure and perform the OAuth2 dance. This, however,
38 is a huge pain in the neck, and it is not entirely clear that all
39 Canvas-using entities have set up OAuth2. Therefore,
41 uses another method: manual user generation of access tokens. In a web
42 browser, while logged into Canvas, go to
44 .D1 Account > Settings > New Access Token
46 and follow the directions to create an access token. It is recommended
47 that you set an expiration date for the token. Write the generated
48 token to ${XDG_CONFIG_HOME}/nci/token. This token should be treated
49 as a password: if a malicious entity acquires the token, they will be
50 able perform actions with your credentials on Canvas.
53 .Xr nci-course-settings 1
54 .Xr nci-create-assignment 1
55 .Xr nci-create-assignment-group 1
56 .Xr nci-delete-assignment 1
57 .Xr nci-delete-assignment-group 1
58 .Xr nci-edit-assignment 1
59 .Xr nci-edit-assignment-group 1
60 .Xr nci-get-assignment-grades 1
61 .Xr nci-list-assignments 1
62 .Xr nci-list-courses 1
63 .Xr nci-put-assignment-grades 1
65 .An S. Gilles Aq Mt sgilles@math.umd.edu