Skip to main content
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

2024 API and CLI Change Log

2024 API and CLI Change Log

The Change Log Archive page displays previous API changes from 2024 noted in the API Change Log. The heading date indicates the date that the API code was made available in the production environment.

2024-04-24

Announcement date: 2024-04-12

Addition

Enroll a User

  • enrollment [sis_user_id]
    • Required if the user is being enrolled from another trusted account. The unique identifier for the user (sis_user_id) must also be accompanied by the root_account parameter. The user_id will be ignored.
  • enrollment[integration_id]
    • Required if the user is being enrolled from another trusted account. The unique identifier for the user (integration_id) must also be accompanied by the root_account parameter. The user_id will be ignored.
  • root_account
    • The domain of the account to search for the user. Will be a no-op unless the sis_user_id or integration_id parameter is also included.

Feature Flags

  • Increase_calendar_context_limit is included in the /api/v1/features/environment endpoint response.

2024-03-27

Announcement date: 2024-03-11

Affected Users: Developers

Deprecate Compromised TLS 1.2 ciphers support from Canvas Load Balancers

  • AES128-GCM-SHA256
  • AES128-SHA
  • AES128-SHA256
  • AES256-GCM-SHA384
  • AES256-SHA
  • AES256-SHA256
  • ECDHE-ECDSA-AES128-SHA
  • ECDHE-ECDSA-AES256-SHA
  • ECDHE-RSA-AES128-SHA
  • ECDHE-RSA-AES256-SHA

Add Support for TLS 1.3 with the following cipher support

  • TLS_AES_128_GCM_SHA256
  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256

2024-03-20

Announcement date: 2024-03-20

Release Data Access Platform (DAP) CLI & Client Library v 1.1.0

DAP CLI

Fixed Issues

  • Fixed error “You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'groups TO canvas__groups' at line 1” when automatically migrating the database schema from version 0.3.x to 1.0.x in MySQL databases. This occurred when the groups table (from the canvas namespace) was already present in the database.
  • Fixed an issue with the client library not cleaning up the temporary directory used for storing downloaded files.
  • Fixed error “ERROR - module 'socket' has no attribute 'TCP_KEEPIDLE'” by removing faulty/unnecessary TCP socket settings.
  • Fixed an issue with the client library not decoding URL-encoded (a.k.a percent-encoded) characters in the database username and password in the database connection string.
  • Database connection string no longer logged in plain text at debug log level.
  • Fixed error “Fatal Python error: none_dealloc: deallocating None” occurring in some cases when replicating data to a database, running the client on Windows using Python version lower than 3.12.

New Features

  • Introduced extensible enumeration (“soft enum”) data type, and an automated database migration required for clients, in preparation for upcoming schema changes in the DAP Query API.

2024-02-28

Announcement date: 2024-02-28

Release Data Access Platform CLI & Client Library v 1.0.0

DAP CLI

Fixed Issues

  • Fixed an issue with time consuming downloads of multiple file parts resulting in an HTTP 400 error.
  • Fixed an issue with calling initdb after dropdb for the same table when using PostgreSQL as the target database, caused by enum types.
  • Changed how the library passes the authentication token to the DAP server after the token is obtained (Authorization header instead of X-InstAuth header).
  • Python stack trace of exceptions is now logged only in case of loglevel ‘debug’.
  • Removed unused filter field from the TableQuery class (inherited by SnapshotQuery and IncrementalQuery).

New Features

  • Added decompress option to multiple functions when using the client library for downloading files.

2024-02-14

Announcement date: 2024-02-02

Addition

Users

  • Log users out of all mobile apps- Permanently expires any active mobile sessions for all users, forcing them to re-authorize.

2024-01-31

Announcement date: 2024-01-19

Addition

Authentication Providers API

  • refresh_metadata

 

2024-01-17

Announcement date: 2024-01-08

Addition

Communication Channels

  • bounce_count

Related idea: [Reports] Add email bounce count to the Communication Channel API

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.