Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/gesso/types/params.ts>EnrollUserParams

A TypeScript API client for Canvas LMS
Latest
interface EnrollUserParams
import { type EnrollUserParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
enrollmentstartat: Date

The start time of the enrollment, in ISO8601 format. e.g. 2012-04-18T23:08:51Z

optional
enrollmentendat: Date

The end time of the enrollment, in ISO8601 format. e.g. 2012-04-18T23:08:51Z

optional
enrollmentuserid: string

The ID of the user to be enrolled in the course.

optional
enrollmenttype: string

Allowed values: StudentEnrollment, TeacherEnrollment, TaEnrollment, ObserverEnrollment, DesignerEnrollment

optional
enrollmentroleid: number

Assigns a custom course-level role to the user.

optional
enrollmentenrollmentstate: string

Allowed values: active, invited, inactive

optional
enrollmentcoursesectionid: number

The ID of the course section to enroll the student in. If the section-specific URL is used, this argument is redundant and will be ignored.

optional
enrollmentlimitprivilegestocoursesection: boolean

If set, the enrollment will only allow the user to see and interact with users enrolled in the section given by course_section_id. For teachers and TAs, this includes grading privileges. Section-limited students will not see any users (including teachers and TAs) not enrolled in their sections. Users may have other enrollments that grant privileges to multiple sections in the same course.

optional
enrollmentnotify: boolean

If true, a notification will be sent to the enrolled user. Notifications are not sent by default.

optional
enrollmentselfenrollmentcode: string

If the current user is not allowed to manage enrollments in this course, but the course allows self-enrollment, the user can self- enroll as a student in the default section by passing in a valid code. When self-enrolling, the user_id must be 'self'. The enrollment_state will be set to 'active' and all other arguments will be ignored.

optional
enrollmentselfenrolled: boolean

If true, marks the enrollment as a self-enrollment, which gives students the ability to drop the course if desired. Defaults to false.

optional
enrollmentassociateduserid: number

For an observer enrollment, the ID of a student to observe. This is a one-off operation; to automatically observe all a student's enrollments (for example, as a parent), please use the User Observees API.