Canvas LMS Connector

Last modified 23 Aug 2024 11:23 +02:00

Identity connector for Canvas LMS.

Functionalitylimited
Development statuscommunity (maintained by community effort)
Support statuscommunity
OriginEvolveum
Support provided byEvolveum
Target systemsCanvas LMS
ProtocolREST
Source codehttps://github.com/Evolveum/connector-canvas-lms

Connector for Canvas LMS teaching and learning software.

This supports Canvas user management and simple enrollment of students and teachers for courses. Both course-level roles are configurable and any other enrollments will not be touched by the connector. Courses are not managed, they are only read-only list of entitlements so the associations can be managed.

Capabilities and Features

Schema

YES

Canvas users are represented as account object class, courses are represented as groups.

Provisioning

YES

Canvas users (accounts) support create/update/delete. Courses are read-only to support entitlements/associations. Only one organization (AKA "account" in Canvas) is supported - ID is configurable.

Live Synchronization

NO

Using last modification timestamps. Supports "Group", "Subject" and "All" object classes.

Password

YES

Optional, or authentication_provider_id can be set for Canvas users.

Activation

YES

Preferable to deletion, to preserve enrollments and grades.

Filtering

NO

Pagination

YES

Pagination using the Private Key which represents object ID

Native attribute names

NO

Check repository README for more information, including limitations and advices about resource setup, including associations.

History

Version Origin Binary Sources Build Date Framework version Bundled with midPoint Description

1.1.2

Evolveum

download jar

Evolveum git repository (v1.1.2)

Aug 23, 2024

Stable version

No

Added configuration option sendEnrollmentNotification and attribute workflow_state on Courses

1.0.1

Evolveum

download jar

Evolveum git repository (v1.0.1)

Jun 25, 2024

Stable version

No

Initial version (with first bugfixes)

Interoperability

  • ConnId 1.5.1.0, tested with midPoint 4.8.x (likely works with newer versions, or with latest 4.4.x)

  • Canvas LMS (tag 2024-03-27.333), tested with standalone deployment only

Support

This connector is supportable by Evolveum.

Evolveum can provide support for this connector. However, support for this connector is not provided on a routine basis and some special arrangements and customizations may be needed. Please contact Evolveum representative for the details.

Licensing

The connector is available under the terms of Apache License 2.0.

Configuration parameters

Parameter Note Example Configuration discovery

Canvas LMS URL

Canvas LMS base URL without /api/v1 path (baseUrl)

https://canvas.example.com

No

Authentication token

Authentication token of the admin user to access the REST API (authToken)

-

No

Canvas Account ID

ID of the Canvas account (organization) containing the courses and users (accountId)

1

No

Canvas Teacher Role ID

ID of the Canvas course-level teacher role (teacherRoleId)

12

No

Canvas Student Role ID

ID of the Canvas course-level student role (studentRoleId)

11

No

See Also

Was this page helpful?
YES NO
Thanks for your feedback