capabilities.work

Enroll User and Confirm

A 3-step recipe with Canvas LMS. We can help you get access.

Recipe · 3 steps

Enroll User and Confirm

with Canvas LMS · Enrolment & Registration

Enroll a user in a course and verify the enrollment exists.

  1. Read the target course to confirm it exists before enrolling a user.
  2. Enroll the supplied user in the course with the requested enrollment type and state.
  3. List the course enrollments to confirm the newly created enrollment is present in the roster.
What you'll need to have ready
  • courseId: The Canvas course id to enroll the user into.
  • userId: The Canvas user id to enroll.
  • enrollmentType: The enrollment type (StudentEnrollment, TeacherEnrollment, TaEnrollment, DesignerEnrollment, ObserverEnrollment).
  • enrollmentState: The desired enrollment state (e.g. active or invited).
  • courseSectionId: Optional section id to enroll the user into a specific section.
For your developer

Arazzo workflow canvas-lms:enroll-user-and-confirm, 3 operations: getCourse → enrollUser → listCourseEnrollments. Specs on APIs.io.