Accessibility Course Scans

circle-exclamation

Accessibility Course Scans API

AccessibilityCourseScansController#createarrow-up-right

POST /api/v1/users/:user_id/educator_accessibility_course_scan

Scope: url:POST|/api/v1/users/:user_id/educator_accessibility_course_scan

Queues a background job that scans all a11y-enabled courses where the user has an active teacher or designer enrollment. Idempotent — if a scan is already queued or running, the existing Progress is returned.

Requires the educator_dashboard feature flag on the root account and a11y_checker_account_statistics on site admin.

Request Parameters:

Parameter
Type
Description

user_id

Required string

The ID of the user, or “self” for the current user. The requesting user may only trigger a scan for themselves.

Returns a Progress object.


This documentation is generated directly from the Canvas LMS source code, available on Githubarrow-up-right.

Last updated

Was this helpful?