enrollUser: Enroll a user in a section or course

In erikpal/bRush: R Canvas Instructure API Client

Enroll a user in a section or course

Description

Create a new section for the provided course.

Usage

enrollUser(
  ID,
  user_id,
  course_section_id = "",
  type = "StudentEnrollment",
  enrollment_state = "active",
  limit_privileges = TRUE,
  notify = "",
  server = "test",
  ...
)

Arguments

ID	Course ID for enrollment
user_id	ID of the user to be enrolled
course_section_id	ID of the course section to enroll student in
type	Character of StudentEnrollment, TeacherEnrollment, TaEnrollment, ObserverEnrollment, DesignerEnrollment
enrollment_state	Character of active, invited, inactive
limit_privileges	Boolean, if true, the enrollment will only allow the user to see and interact with users enrolled in the section given by course_section_id
notify	Boolean, if true, a notification will be sent to the enrolled user.
server	Test, beta, production, or other name in R.environ OR full url of server
...	Optional page options to pass to processRequest

erikpal/bRush documentation built on May 9, 2023, 8:27 p.m.