Ally needs to be able to sync data such as courses and files from the Canvas REST API to generate reports and provide instructor feedback. To do this securely, an access token needs to be generated.
This is only available to administrators in the Instructure Canvas LMS.
Step 1: Create a new account role
Having a new account role allows you to define the permissions the Ally service will have. While you can see specifically which permissions are granted to the Ally service in the Canvas administration interface, at a high level these permissions allow Ally to download term, course, and file information for generating accessibility feedback and alternative versions. It also allows Ally to delete and replace file content which are important operations in helping instructors remediate their course content.
- Sign into your Canvas installation as an administrator.
- Select Admin icon in the left hand navigation and select your account in the window that slides open.
- Select Permissions and select Account Roles.
- Select Add Role.
- Save a role named Ally. Once saved, a new column named Ally should be in the table.
- In the Ally column, enable these permissions.
- Courses - add / edit / delete
- Courses - view list
- Users - act as
- Announcements - view
- Assignments and Quizzes - add / edit / delete
- Course Content - add / edit / delete
- Course Content - view
- Course Files - add / edit / delete
- Discussions - moderate
- Discussions - view
- Pages - add / edit / delete
Step 2: Create a new user
It's considered best practice to create a new user for each integration with Canvas. If users for your institution are created directly in Canvas, please follow these instructions to do so. However, if users are managed in an external system such as SIS or LDAP, please follow the process for creating users for use in Canvas for your institution, then continue to grant the new user the Ally role.
If users are created directly in Canvas for your institution, please complete these steps.
- Navigate to the Users page under your account management.
- Select New User and add a new user called Ally.
- Make sure the Email the user about this account creation check box is selected.
- Select the link you received in your email inbox to verify the account.
- Navigate to the Settings page under your account management.
- Select Admins.
- Select the + Account Admins button to add the user.
- In the form that popped open, ensure the Ally role is selected in the menu.
- If users are created directly in Canvas at your institution, you are prompted to enter the email address of the user that you created in the previous section. If your user was created in an external system such as SIS or LDAP, please enter the identifier of the user requested by Canvas in the field.
- Select Continue...
- If the user was found, select OK Looks Good.
- Confirm the Ally user was added to the list.
Step 4: Generate an access token
In this final step, we'll generate an access token that can be used by the Ally service to safely and securely interact with the REST API.
- Sign in as the Ally user.
Masquerading as the Ally user won't work for these steps as Canvas forbids administrators setting up an access token on another user's behalf.
- Navigate to the user's settings by selecting Account in the left hand navigation followed by selecting on the Settings link in the new window.
- Select New Access Token.
- Enter Ally.ac integration as the purpose of the token, the expiration timestamp field can be left blank.
- Select Generate Token.
- A new window should appear that contains the access token. Please copy this token now, as once you leave this page you will no longer be able to access it.