Skip to content

Commit 6bab765

Browse files
LTI1.3 JSON URL (#432)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized LTI 1.3 Canvas setup into Option 1 (JSON configuration URL) and Option 2 (manual entry) with clearer step flow. * Consolidated copy/paste guidance into concise table-style steps and added tabbed examples for Target Link URI and Icon URL. * Split Editor Button and Course Navigation into separate sections with updated images and renamed captions. * Expanded Part 2 with steps covering LTI Advantage Services, placements, privacy, and domain/tool ID. * Added guideline to use the list-table directive when authoring reStructuredText tables. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent a9ba70d commit 6bab765

4 files changed

Lines changed: 86 additions & 22 deletions

File tree

.coderabbit.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ reviews:
2121
instructions: |
2222
Review files for:
2323
- Consistent formatting (e.g., headings, lists, links).
24+
- Anywhere there are tables, they should use `list-table`.
2425
- Clear and concise language.
2526
- Correct grammar and spelling.
2627
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
105 KB
Loading

source/img/lti-json-url.png

138 KB
Loading

source/instructors/admin/integration/lti1-3Canvas.rst

Lines changed: 85 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ The Canvas user who carries out these steps must be a system administrator.
2020
When copying links, please use the copy button adjacent to each link to ensure accuracy and prevent linking errors.
2121

2222

23-
2423
**In Codio:**
2524

2625
1. Click your username in the top-right corner, then select **Organization** from the menu. In the Organizations area, click the name of your organization.
@@ -39,25 +38,66 @@ The Canvas user who carries out these steps must be a system administrator.
3938

4039
5. Click on **Developer Key** and select **+LTI key**.
4140

42-
6. Complete the **Key Name, Title** and **Description** fields. Make sure to set the **method** to **Manual Entry**.
41+
(Step 6, Option 1) Using JSON configuration Url
42+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4343

44-
|image2|
44+
You can use a JSON configuration URL to automatically configure most Canvas settings:
45+
46+
.. image:: /img/lti-json-url.png
47+
:alt: Canvas configuration for JSON configuration Url
48+
:width: 80%
49+
50+
You only need to configure:
51+
52+
.. list-table::
53+
:header-rows: 1
54+
:widths: 30 70
55+
56+
* - **Value**
57+
- **What to add**
58+
* - **Key Name:**
59+
- A name for the Tool, i.e.: "Codio"
60+
* - **Owner Email:**
61+
- An email, you can use your own email.
62+
* - **Redirect URIs:**
63+
- Paste the Redirect URL from your Codio integration
64+
* - Set the Method as **Enter URL**
65+
-
66+
* - **JSON URL**
67+
- Paste the URL from **Canvas JSON configuration Url**
68+
69+
.. note::
70+
If you use the JSON configuration URL method, skip to **Part 2**. To manually configure everything, continue with the steps below.
4571

72+
(Step 6, Option 2) Completing Canvas Steps Manually
73+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4674

47-
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
48-
| | **Copy** | **Paste** |
49-
+======+========================================================+=======================================================================+
50-
| 7 | From Codio, under **LTI 1.3 Integration, copy the** | Paste it into the **Canvas Redirect URI** field. |
51-
| | **Redirect URL** | |
52-
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
53-
| 8 | Copy the **LTI URL** | Paste it into the **Target Link URI field** in Canvas. |
54-
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
55-
| 9 | Copy the **Initiate Login URL** | Paste it into the **OpenID Connect Initiation URL**. |
56-
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
57-
| 10 | In Canvas, change **JWK Method** to **Public JWK URL**.| |
58-
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
59-
| 11 | From Codio, copy the **Keyset URL** | Paste it into the **Public JWK URL** field. |
60-
+------+--------------------------------------------------------+-----------------------------------------------------------------------+
75+
Complete the **Key Name, Title** and **Description** fields. Make sure to set the **method** to **Manual Entry**.
76+
77+
|image2|
78+
79+
.. list-table::
80+
:header-rows: 1
81+
:widths: 5 50 50
82+
83+
* -
84+
- **Copy**
85+
- **Paste**
86+
* - 7
87+
- From Codio, under **LTI 1.3 Integration, copy the Redirect URL**
88+
- Paste it into the **Canvas Redirect URI** field.
89+
* - 8
90+
- Copy the **LTI URL**
91+
- Paste it into the **Target Link URI** field in Canvas.
92+
* - 9
93+
- Copy the **Initiate Login URL**
94+
- Paste it into the **OpenID Connect Initiation URL**.
95+
* - 10
96+
- In Canvas, change **JWK Method** to **Public JWK URL**.
97+
-
98+
* - 11
99+
- From Codio, copy the **Keyset URL**
100+
- Paste it into the **Public JWK URL** field.
61101

62102

63103
|image3|
@@ -100,12 +140,11 @@ Link Selection and Assignment Selection
100140
https://static-assets.codio.com/dashboard/images/icons/favicon-16x16.da14ae918fd9bc3b.png
101141

102142

103-
Course Navigation and Editor Button
104-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105-
143+
Editor Button
144+
~~~~~~~~~~~~~
106145

107146
.. image:: /img/canvascourseeditortselect.png
108-
:alt: Canvas Course Navigation and Editor Button placement
147+
:alt: Canvas Editor Button placement
109148
:width: 750px
110149

111150

@@ -114,7 +153,31 @@ Course Navigation and Editor Button
114153
.. code-tab:: text
115154
:caption: Target Link URI
116155

117-
https://apollo.codio.com/lti/resource_selection
156+
https://apollo.codio.com/lti/editor_button
157+
158+
.. tabs::
159+
160+
.. code-tab:: text
161+
:caption: Icon URL
162+
163+
https://static-assets.codio.com/dashboard/images/icons/favicon-16x16.da14ae918fd9bc3b.png
164+
165+
166+
Course Navigation
167+
~~~~~~~~~~~~~~~~~
168+
169+
170+
.. image:: /img/canvascoursecoursetselect.png
171+
:alt: Canvas Course Navigation placement
172+
:width: 750px
173+
174+
175+
.. tabs::
176+
177+
.. code-tab:: text
178+
:caption: Target Link URI
179+
180+
https://apollo.codio.com/lti/course_navigation
118181

119182
.. tabs::
120183

0 commit comments

Comments
 (0)