Canvas LMS REST API

openapi: 3.1.0
info:
  title: Canvas LMS REST API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: |-
    The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.

    PROVENANCE: this document is a mechanical conversion of the 144 first-party Swagger 1.2 resource documents Instructure publishes at https://canvas.instructure.com/doc/api/api-docs.json and https://canvas.instructure.com/doc/api/<resource>.json. Every path, operation, operationId (Canvas "nickname"), parameter, model and response message comes from those documents verbatim; the verbatim harvest is archived in openapi/_original/swagger-1.2/. Nothing here was authored by API Evangelist except the OpenAPI 3.1 scaffolding, the servers block (from the Swagger basePath) and the securitySchemes block (from https://canvas.instructure.com/doc/api/file.oauth.html).
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
externalDocs:
  description: Canvas LMS REST API Documentation
  url: https://canvas.instructure.com/doc/api/
x-generated-from: https://canvas.instructure.com/doc/api/api-docs.json
x-provenance:
  method: derived
  derived_by: API Evangelist enrichment pipeline (Swagger 1.2 -> OpenAPI 3.1 conversion)
  source: openapi/_original/swagger-1.2/*.json (144 verbatim first-party Swagger 1.2 documents)
  source_url: https://canvas.instructure.com/doc/api/api-docs.json
  fetched: '2026-09-05'
  http_status: 200
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Access Tokens
  x-resource: access_tokens
  externalDocs:
    url: https://canvas.instructure.com/doc/api/access_tokens.html
- name: Accessibility Course Scans
  x-resource: accessibility_course_scans
  externalDocs:
    url: https://canvas.instructure.com/doc/api/accessibility_course_scans.html
- name: Accessibility Course Statistics
  x-resource: accessibility_course_statistics
  externalDocs:
    url: https://canvas.instructure.com/doc/api/accessibility_course_statistics.html
- name: Account Calendars
  x-resource: account_calendars
  externalDocs:
    url: https://canvas.instructure.com/doc/api/account_calendars.html
- name: Account Domain Lookups
  x-resource: account_domain_lookups
  externalDocs:
    url: https://canvas.instructure.com/doc/api/account_domain_lookups.html
- name: Account Notifications
  x-resource: account_notifications
  externalDocs:
    url: https://canvas.instructure.com/doc/api/account_notifications.html
- name: Account Reports
  x-resource: account_reports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/account_reports.html
- name: Accounts
  x-resource: accounts
  externalDocs:
    url: https://canvas.instructure.com/doc/api/accounts.html
- name: Accounts (Lti)
  x-resource: accounts_(lti)
  externalDocs:
    url: https://canvas.instructure.com/doc/api/accounts_(lti).html
- name: Admins
  x-resource: admins
  externalDocs:
    url: https://canvas.instructure.com/doc/api/admins.html
- name: Ai Conversations
  x-resource: ai_conversations
  externalDocs:
    url: https://canvas.instructure.com/doc/api/ai_conversations.html
- name: Ai Experiences
  x-resource: ai_experiences
  externalDocs:
    url: https://canvas.instructure.com/doc/api/ai_experiences.html
- name: Analytics
  x-resource: analytics
  externalDocs:
    url: https://canvas.instructure.com/doc/api/analytics.html
- name: Announcement External Feeds
  x-resource: announcement_external_feeds
  externalDocs:
    url: https://canvas.instructure.com/doc/api/announcement_external_feeds.html
- name: Announcements
  x-resource: announcements
  externalDocs:
    url: https://canvas.instructure.com/doc/api/announcements.html
- name: Api Token Scopes
  x-resource: api_token_scopes
  externalDocs:
    url: https://canvas.instructure.com/doc/api/api_token_scopes.html
- name: Appointment Groups
  x-resource: appointment_groups
  externalDocs:
    url: https://canvas.instructure.com/doc/api/appointment_groups.html
- name: Assessment Question Banks
  x-resource: assessment_question_banks
  externalDocs:
    url: https://canvas.instructure.com/doc/api/assessment_question_banks.html
- name: Asset Processor
  x-resource: asset_processor
  externalDocs:
    url: https://canvas.instructure.com/doc/api/asset_processor.html
- name: Assignment Extensions
  x-resource: assignment_extensions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/assignment_extensions.html
- name: Assignment Groups
  x-resource: assignment_groups
  externalDocs:
    url: https://canvas.instructure.com/doc/api/assignment_groups.html
- name: Assignments
  x-resource: assignments
  externalDocs:
    url: https://canvas.instructure.com/doc/api/assignments.html
- name: Authentication Providers
  x-resource: authentication_providers
  externalDocs:
    url: https://canvas.instructure.com/doc/api/authentication_providers.html
- name: Authentications Log
  x-resource: authentications_log
  externalDocs:
    url: https://canvas.instructure.com/doc/api/authentications_log.html
- name: Blackout Dates
  x-resource: blackout_dates
  externalDocs:
    url: https://canvas.instructure.com/doc/api/blackout_dates.html
- name: Block Editor Template
  x-resource: block_editor_template
  externalDocs:
    url: https://canvas.instructure.com/doc/api/block_editor_template.html
- name: Blueprint Courses
  x-resource: blueprint_courses
  externalDocs:
    url: https://canvas.instructure.com/doc/api/blueprint_courses.html
- name: Bookmarks
  x-resource: bookmarks
  externalDocs:
    url: https://canvas.instructure.com/doc/api/bookmarks.html
- name: Brand Configs
  x-resource: brand_configs
  externalDocs:
    url: https://canvas.instructure.com/doc/api/brand_configs.html
- name: Calendar Events
  x-resource: calendar_events
  externalDocs:
    url: https://canvas.instructure.com/doc/api/calendar_events.html
- name: Canvas Career Experiences
  x-resource: canvas_career_experiences
  externalDocs:
    url: https://canvas.instructure.com/doc/api/canvas_career_experiences.html
- name: Canvas Career User Context
  x-resource: canvas_career_user_context
  externalDocs:
    url: https://canvas.instructure.com/doc/api/canvas_career_user_context.html
- name: Collaborations
  x-resource: collaborations
  externalDocs:
    url: https://canvas.instructure.com/doc/api/collaborations.html
- name: Comm Messages
  x-resource: comm_messages
  externalDocs:
    url: https://canvas.instructure.com/doc/api/comm_messages.html
- name: Communication Channels
  x-resource: communication_channels
  externalDocs:
    url: https://canvas.instructure.com/doc/api/communication_channels.html
- name: Conferences
  x-resource: conferences
  externalDocs:
    url: https://canvas.instructure.com/doc/api/conferences.html
- name: Content Exports
  x-resource: content_exports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/content_exports.html
- name: Content Migrations
  x-resource: content_migrations
  externalDocs:
    url: https://canvas.instructure.com/doc/api/content_migrations.html
- name: Content Security Policy Settings
  x-resource: content_security_policy_settings
  externalDocs:
    url: https://canvas.instructure.com/doc/api/content_security_policy_settings.html
- name: Content Shares
  x-resource: content_shares
  externalDocs:
    url: https://canvas.instructure.com/doc/api/content_shares.html
- name: Conversations
  x-resource: conversations
  externalDocs:
    url: https://canvas.instructure.com/doc/api/conversations.html
- name: Course Audit Log
  x-resource: course_audit_log
  externalDocs:
    url: https://canvas.instructure.com/doc/api/course_audit_log.html
- name: Course Pace
  x-resource: course_pace
  externalDocs:
    url: https://canvas.instructure.com/doc/api/course_pace.html
- name: Course Quiz Extensions
  x-resource: course_quiz_extensions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/course_quiz_extensions.html
- name: Course Reports
  x-resource: course_reports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/course_reports.html
- name: Courses
  x-resource: courses
  externalDocs:
    url: https://canvas.instructure.com/doc/api/courses.html
- name: Custom Gradebook Columns
  x-resource: custom_gradebook_columns
  externalDocs:
    url: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html
- name: Developer Key Account Bindings
  x-resource: developer_key_account_bindings
  externalDocs:
    url: https://canvas.instructure.com/doc/api/developer_key_account_bindings.html
- name: Developer Keys
  x-resource: developer_keys
  externalDocs:
    url: https://canvas.instructure.com/doc/api/developer_keys.html
- name: Discovery Pages
  x-resource: discovery_pages
  externalDocs:
    url: https://canvas.instructure.com/doc/api/discovery_pages.html
- name: Discussion Topics
  x-resource: discussion_topics
  externalDocs:
    url: https://canvas.instructure.com/doc/api/discussion_topics.html
- name: E Portfolios
  x-resource: e_portfolios
  externalDocs:
    url: https://canvas.instructure.com/doc/api/e_portfolios.html
- name: E Pub Exports
  x-resource: e_pub_exports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/e_pub_exports.html
- name: Enrollment Terms
  x-resource: enrollment_terms
  externalDocs:
    url: https://canvas.instructure.com/doc/api/enrollment_terms.html
- name: Enrollments
  x-resource: enrollments
  externalDocs:
    url: https://canvas.instructure.com/doc/api/enrollments.html
- name: Error Reports
  x-resource: error_reports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/error_reports.html
- name: External Tools
  x-resource: external_tools
  externalDocs:
    url: https://canvas.instructure.com/doc/api/external_tools.html
- name: Favorites
  x-resource: favorites
  externalDocs:
    url: https://canvas.instructure.com/doc/api/favorites.html
- name: Feature Flags
  x-resource: feature_flags
  externalDocs:
    url: https://canvas.instructure.com/doc/api/feature_flags.html
- name: Files
  x-resource: files
  externalDocs:
    url: https://canvas.instructure.com/doc/api/files.html
- name: Grade Change Log
  x-resource: grade_change_log
  externalDocs:
    url: https://canvas.instructure.com/doc/api/grade_change_log.html
- name: Gradebook History
  x-resource: gradebook_history
  externalDocs:
    url: https://canvas.instructure.com/doc/api/gradebook_history.html
- name: Grading Period Sets
  x-resource: grading_period_sets
  externalDocs:
    url: https://canvas.instructure.com/doc/api/grading_period_sets.html
- name: Grading Periods
  x-resource: grading_periods
  externalDocs:
    url: https://canvas.instructure.com/doc/api/grading_periods.html
- name: Grading Standards
  x-resource: grading_standards
  externalDocs:
    url: https://canvas.instructure.com/doc/api/grading_standards.html
- name: Graph Ql
  x-resource: graph_ql
  externalDocs:
    url: https://canvas.instructure.com/doc/api/graph_ql.html
- name: Group Categories
  x-resource: group_categories
  externalDocs:
    url: https://canvas.instructure.com/doc/api/group_categories.html
- name: Groups
  x-resource: groups
  externalDocs:
    url: https://canvas.instructure.com/doc/api/groups.html
- name: History
  x-resource: history
  externalDocs:
    url: https://canvas.instructure.com/doc/api/history.html
- name: Inst Access Tokens
  x-resource: inst_access_tokens
  externalDocs:
    url: https://canvas.instructure.com/doc/api/inst_access_tokens.html
- name: Jw Ts
  x-resource: jw_ts
  externalDocs:
    url: https://canvas.instructure.com/doc/api/jw_ts.html
- name: Late Policy
  x-resource: late_policy
  externalDocs:
    url: https://canvas.instructure.com/doc/api/late_policy.html
- name: Learning Object Dates
  x-resource: learning_object_dates
  externalDocs:
    url: https://canvas.instructure.com/doc/api/learning_object_dates.html
- name: Line Items
  x-resource: line_items
  externalDocs:
    url: https://canvas.instructure.com/doc/api/line_items.html
- name: Live Assessments
  x-resource: live_assessments
  externalDocs:
    url: https://canvas.instructure.com/doc/api/live_assessments.html
- name: Logins
  x-resource: logins
  externalDocs:
    url: https://canvas.instructure.com/doc/api/logins.html
- name: Lti Context Controls
  x-resource: lti_context_controls
  externalDocs:
    url: https://canvas.instructure.com/doc/api/lti_context_controls.html
- name: Lti Launch Definitions
  x-resource: lti_launch_definitions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/lti_launch_definitions.html
- name: Lti Registrations
  x-resource: lti_registrations
  externalDocs:
    url: https://canvas.instructure.com/doc/api/lti_registrations.html
- name: Lti Resource Links
  x-resource: lti_resource_links
  externalDocs:
    url: https://canvas.instructure.com/doc/api/lti_resource_links.html
- name: Media Objects
  x-resource: media_objects
  externalDocs:
    url: https://canvas.instructure.com/doc/api/media_objects.html
- name: Moderated Grading
  x-resource: moderated_grading
  externalDocs:
    url: https://canvas.instructure.com/doc/api/moderated_grading.html
- name: Modules
  x-resource: modules
  externalDocs:
    url: https://canvas.instructure.com/doc/api/modules.html
- name: Names And Role
  x-resource: names_and_role
  externalDocs:
    url: https://canvas.instructure.com/doc/api/names_and_role.html
- name: New Quiz Items
  x-resource: new_quiz_items
  externalDocs:
    url: https://canvas.instructure.com/doc/api/new_quiz_items.html
- name: New Quizzes
  x-resource: new_quizzes
  externalDocs:
    url: https://canvas.instructure.com/doc/api/new_quizzes.html
- name: New Quizzes Accommodations
  x-resource: new_quizzes_accommodations
  externalDocs:
    url: https://canvas.instructure.com/doc/api/new_quizzes_accommodations.html
- name: New Quizzes Reports
  x-resource: new_quizzes_reports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/new_quizzes_reports.html
- name: Notice Handlers
  x-resource: notice_handlers
  externalDocs:
    url: https://canvas.instructure.com/doc/api/notice_handlers.html
- name: Notification Preferences
  x-resource: notification_preferences
  externalDocs:
    url: https://canvas.instructure.com/doc/api/notification_preferences.html
- name: Originality Reports
  x-resource: originality_reports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/originality_reports.html
- name: Outcome Groups
  x-resource: outcome_groups
  externalDocs:
    url: https://canvas.instructure.com/doc/api/outcome_groups.html
- name: Outcome Imports
  x-resource: outcome_imports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/outcome_imports.html
- name: Outcome Results
  x-resource: outcome_results
  externalDocs:
    url: https://canvas.instructure.com/doc/api/outcome_results.html
- name: Outcomes
  x-resource: outcomes
  externalDocs:
    url: https://canvas.instructure.com/doc/api/outcomes.html
- name: Pages
  x-resource: pages
  externalDocs:
    url: https://canvas.instructure.com/doc/api/pages.html
- name: Peer Reviews
  x-resource: peer_reviews
  externalDocs:
    url: https://canvas.instructure.com/doc/api/peer_reviews.html
- name: Plagiarism Detection Platform Assignments
  x-resource: plagiarism_detection_platform_assignments
  externalDocs:
    url: https://canvas.instructure.com/doc/api/plagiarism_detection_platform_assignments.html
- name: Plagiarism Detection Platform Users
  x-resource: plagiarism_detection_platform_users
  externalDocs:
    url: https://canvas.instructure.com/doc/api/plagiarism_detection_platform_users.html
- name: Plagiarism Detection Submissions
  x-resource: plagiarism_detection_submissions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/plagiarism_detection_submissions.html
- name: Planner
  x-resource: planner
  externalDocs:
    url: https://canvas.instructure.com/doc/api/planner.html
- name: Poll Choices
  x-resource: poll_choices
  externalDocs:
    url: https://canvas.instructure.com/doc/api/poll_choices.html
- name: Poll Sessions
  x-resource: poll_sessions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/poll_sessions.html
- name: Poll Submissions
  x-resource: poll_submissions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/poll_submissions.html
- name: Polls
  x-resource: polls
  externalDocs:
    url: https://canvas.instructure.com/doc/api/polls.html
- name: Portfolio Notifications
  x-resource: portfolio_notifications
  externalDocs:
    url: https://canvas.instructure.com/doc/api/portfolio_notifications.html
- name: Proficiency Ratings
  x-resource: proficiency_ratings
  externalDocs:
    url: https://canvas.instructure.com/doc/api/proficiency_ratings.html
- name: Progress
  x-resource: progress
  externalDocs:
    url: https://canvas.instructure.com/doc/api/progress.html
- name: Public Jwk
  x-resource: public_jwk
  externalDocs:
    url: https://canvas.instructure.com/doc/api/public_jwk.html
- name: Quiz Assignment Overrides
  x-resource: quiz_assignment_overrides
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_assignment_overrides.html
- name: Quiz Extensions
  x-resource: quiz_extensions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_extensions.html
- name: Quiz Ip Filters
  x-resource: quiz_ip_filters
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_ip_filters.html
- name: Quiz Question Groups
  x-resource: quiz_question_groups
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_question_groups.html
- name: Quiz Questions
  x-resource: quiz_questions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_questions.html
- name: Quiz Reports
  x-resource: quiz_reports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_reports.html
- name: Quiz Statistics
  x-resource: quiz_statistics
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_statistics.html
- name: Quiz Submission Events
  x-resource: quiz_submission_events
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_submission_events.html
- name: Quiz Submission Files
  x-resource: quiz_submission_files
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_submission_files.html
- name: Quiz Submission Questions
  x-resource: quiz_submission_questions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_submission_questions.html
- name: Quiz Submission User List
  x-resource: quiz_submission_user_list
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html
- name: Quiz Submissions
  x-resource: quiz_submissions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quiz_submissions.html
- name: Quizzes
  x-resource: quizzes
  externalDocs:
    url: https://canvas.instructure.com/doc/api/quizzes.html
- name: Result
  x-resource: result
  externalDocs:
    url: https://canvas.instructure.com/doc/api/result.html
- name: Roles
  x-resource: roles
  externalDocs:
    url: https://canvas.instructure.com/doc/api/roles.html
- name: Rubrics
  x-resource: rubrics
  externalDocs:
    url: https://canvas.instructure.com/doc/api/rubrics.html
- name: Sandboxes
  x-resource: sandboxes
  externalDocs:
    url: https://canvas.instructure.com/doc/api/sandboxes.html
- name: Score
  x-resource: score
  externalDocs:
    url: https://canvas.instructure.com/doc/api/score.html
- name: Search
  x-resource: search
  externalDocs:
    url: https://canvas.instructure.com/doc/api/search.html
- name: Sections
  x-resource: sections
  externalDocs:
    url: https://canvas.instructure.com/doc/api/sections.html
- name: Services
  x-resource: services
  externalDocs:
    url: https://canvas.instructure.com/doc/api/services.html
- name: Shared Brand Configs
  x-resource: shared_brand_configs
  externalDocs:
    url: https://canvas.instructure.com/doc/api/shared_brand_configs.html
- name: Sis Import Errors
  x-resource: sis_import_errors
  externalDocs:
    url: https://canvas.instructure.com/doc/api/sis_import_errors.html
- name: Sis Imports
  x-resource: sis_imports
  externalDocs:
    url: https://canvas.instructure.com/doc/api/sis_imports.html
- name: Sis Integration
  x-resource: sis_integration
  externalDocs:
    url: https://canvas.instructure.com/doc/api/sis_integration.html
- name: Smart Search
  x-resource: smart_search
  externalDocs:
    url: https://canvas.instructure.com/doc/api/smart_search.html
- name: Study Assist
  x-resource: study_assist
  externalDocs:
    url: https://canvas.instructure.com/doc/api/study_assist.html
- name: Submission Comments
  x-resource: submission_comments
  externalDocs:
    url: https://canvas.instructure.com/doc/api/submission_comments.html
- name: Submissions
  x-resource: submissions
  externalDocs:
    url: https://canvas.instructure.com/doc/api/submissions.html
- name: Tabs
  x-resource: tabs
  externalDocs:
    url: https://canvas.instructure.com/doc/api/tabs.html
- name: Temporary Enrollment Pairings
  x-resource: temporary_enrollment_pairings
  externalDocs:
    url: https://canvas.instructure.com/doc/api/temporary_enrollment_pairings.html
- name: User Observees
  x-resource: user_observees
  externalDocs:
    url: https://canvas.instructure.com/doc/api/user_observees.html
- name: Users
  x-resource: users
  externalDocs:
    url: https://canvas.instructure.com/doc/api/users.html
- name: Webhooks Subscriptions For Plagiarism Platform
  x-resource: webhooks_subscriptions_for_plagiarism_platform
  externalDocs:
    url: https://canvas.instructure.com/doc/api/webhooks_subscriptions_for_plagiarism_platform.html
- name: What If Grades
  x-resource: what_if_grades
  externalDocs:
    url: https://canvas.instructure.com/doc/api/what_if_grades.html
paths:
  /v1/users/{user_id}/user_generated_tokens:
    get:
      tags:
      - Access Tokens
      operationId: list_access_tokens_for_user
      summary: List access tokens for a user
      description: |-
        Returns a list of manually generated access tokens for the specified user.
        Note that the actual token values are only returned when the token is first created.
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: per_page
        in: query
        schema:
          type: integer
          format: int64
        required: false
        description: The number of results to return per page. Defaults to 10. Maximum of 100.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Token'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/access_tokens.html
  /v1/users/{user_id}/tokens/{id}:
    get:
      tags:
      - Access Tokens
      operationId: show_access_token
      summary: Show an access token
      description: The ID can be the actual database ID of the token, or the 'token_hint' value.
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: ID
      responses:
        '200':
          description: Success, no content returned
      externalDocs:
        url: https://canvas.instructure.com/doc/api/access_tokens.html
    put:
      tags:
      - Access Tokens
      operationId: update_access_token
      summary: Update an access token
      description: |-
        Update an existing access token.

        The ID can be the actual database ID of the token, or the 'token_hint' value.

        Regenerating an expired token requires a new expiration date.
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: ID
      requestBody:
        required: false
        content:
          application/json:
            schema: &id001
              type: object
              properties:
                token[purpose]:
                  type: string
                  description: The purpose of the token.
                token[expires_at]:
                  type: string
                  format: date-time
                  description: The time at which the token will expire.
                token[scopes]:
                  type: array
                  items:
                    type: array
                    items: {}
                  description: The scopes to associate with the token.
                token[regenerate]:
                  type: boolean
                  description: Regenerate the actual token.
          application/x-www-form-urlencoded:
            schema: *id001
      responses:
        '200':
          description: Success, no content returned
      externalDocs:
        url: https://canvas.instructure.com/doc/api/access_tokens.html
    delete:
      tags:
      - Access Tokens
      operationId: delete_access_token
      summary: Delete an access token
      description: The ID can be the actual database ID of the token, or the 'token_hint' value.
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: ID
      responses:
        '200':
          description: Success, no content returned
      externalDocs:
        url: https://canvas.instructure.com/doc/api/access_tokens.html
  /v1/users/{user_id}/tokens:
    post:
      tags:
      - Access Tokens
      operationId: create_access_token
      summary: Create an access token
      description: |-
        Create a new access token for the specified user.
        If the user is not the current user, the token will be created as "pending",
        and must be activated by the user before it can be used.
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      requestBody:
        required: false
        content:
          application/json:
            schema: &id002
              type: object
              properties:
                token[purpose]:
                  type: string
                  description: The purpose of the token.
                token[expires_at]:
                  type: string
                  format: date-time
                  description: The time at which the token will expire.
                token[scopes]:
                  type: array
                  items:
                    type: array
                    items: {}
                  description: |-
                    The scopes to associate with the token.
                    Ignored if the default developer key does not have the "enable scopes" option enabled.
                    In such cases, the token will inherit the user's permissions instead.
              required:
              - token[purpose]
          application/x-www-form-urlencoded:
            schema: *id002
      responses:
        '200':
          description: Success, no content returned
      externalDocs:
        url: https://canvas.instructure.com/doc/api/access_tokens.html
  /v1/users/{user_id}/educator_accessibility_course_scan:
    post:
      tags:
      - Accessibility Course Scans
      operationId: trigger_accessibility_course_scan
      summary: Trigger accessibility course scan
      description: |-
        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.
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: |-
          The ID of the user, or "self" for the current user.
          The requesting user may only trigger a scan for themselves.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                x-canvas-declared-type: Progress
      externalDocs:
        url: https://canvas.instructure.com/doc/api/accessibility_course_scans.html
  /v1/users/{user_id}/educator_accessibility_course_statistics:
    get:
      tags:
      - Accessibility Course Statistics
      operationId: list_accessibility_course_statistics
      summary: List accessibility course statistics
      description: |-
        Returns per-course accessibility issue statistics for the current user's
        active teacher and designer courses. Only courses where the accessibility
        checker is enabled and whose workflow state is neither completed nor deleted
        are included. Only statistic records with workflow_state "active" are returned.

        Requires the educator_dashboard feature flag to be enabled on the root
        account, and a11y_checker_account_statistics on site admin plus a11y_checker
        on the account (i.e. a11y_checker_account_statistics? must be true).
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: |-
          The ID of the user, or "self" for the current user.
          The requesting user may only retrieve their own statistics.
      - name: enrollment_term_id
        in: query
        schema:
          type: string
        required: false
        description: |-
          When present, only include courses that belong to the given enrollment
          term(s). Accepts a single term id or an array
          (enrollment_term_id[]=1&enrollment_term_id[]=2), and each value may be a
          term id or SIS term id. Returns 404 if any given term does not exist in
          this account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccessibilityCourseStatistic'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/accessibility_course_statistics.html
  /v1/users/{user_id}/educator_accessibility_course_terms:
    get:
      tags:
      - Accessibility Course Statistics
      operationId: list_accessibility_course_statistic_terms
      summary: List accessibility course statistic terms
      description: |-
        Returns the distinct enrollment terms that the current user's active teacher
        and designer courses belong to -- the same courses reported by the List
        accessibility course statistics endpoint. Use this to populate a term filter
        for that endpoint. There is no "all terms" entry; "all terms" is represented
        by omitting the enrollment_term_id filter.

        Requires the same account settings and feature flags as the statistics
        endpoint.
      parameters:
      - name: user_id
        in: path
        schema:
          type: string
        required: true
        description: |-
          The ID of the user, or "self" for the current user.
          The requesting user may only retrieve their own terms.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            

# --- truncated at 32 KB (2386 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-lms-openapi.yml