cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Canvas Platform Breaking Changes

Canvas Platform Breaking Changes

The breaking changes page displays a comprehensive list of all deprecation removals noted in the Canvas API Change Log , GraphQL API Change Log, or Canvas Platform Change Log. Logs can be located in the Canvas Log Archive by Year.

Canvas may deprecate API elements according to the timelines indicated in the Canvas API Policy page.

The heading date indicates the date that the intended code will be removed from the production environment.

Subscribe this document for content updates. To learn how, see Help: Subscriptions

Deprecation of Numerical Variable Substitutions in LTI 1.3 Launch

Certain variable substitutions in custom claim for the LTI 1.3 launch were identified as containing numerical values rather than string values as required by the specification. These numerical variable substitutions will be deprecated and changed to string values on 2022-10-15. The feature flag variable_substitution_numeric_to_string controls this change, and can be used in individual environments to test and determine if this will be an issue for your tool. The affected fields are:

  • ​​com.instructure.OriginalityReport.id
  • com.instructure.Submission.id
  • com.instructure.File.id
  • Canvas.account.id
  • Canvas.rootAccount.id
  • Canvas.root_account.id
  • Canvas.root_account.global_id
  • Canvas.shard.id
  • com.instructure.Group.id
  • Canvas.course.id
  • Canvas.externalTool.global_id
  • Canvas.assignment.id
  • Canvas.assignment.pointsPossible
  • Canvas.assignment.allowedAttempts
  • Canvas.assignment.submission.studentAttempts
  • Canvas.user.id
  • Canvas.user.globalId
  • User.id
  • Canvas.file.media.duration
  • Canvas.file.media.size
  • Canvas.masqueradingUser.id
  • Canvas.moduleItem.id

Announcement date: 2022-06-08

Deprecation date: 2022-10-15

 

Authentication

An unauthorized response from the JSON API will return a 403 (Forbidden) instead of a 401 code, to be more in line with HTTP standards. Additionally, localization of the “status” field in unauthenticated or unauthorized JSON errors is deprecated; the status will always be given in English.

Announcement date: 2022-02-16

Deprecation date: 2022-05-25

Labels (2)
Was this article helpful? Yes No
Embed this guide in your Canvas course:

Note: You can only embed guides in Canvas courses. Embedding on other sites is not supported.