canvas enrollments create
canvas enrollments create¶
Enroll a user in a course
Synopsis¶
Enroll a user in a course.
Enrollment Types: StudentEnrollment - Student role TeacherEnrollment - Teacher/Instructor role TaEnrollment - Teaching Assistant role ObserverEnrollment - Observer role DesignerEnrollment - Course Designer role
Enrollment States: active - Active enrollment invited - Invited (default) inactive - Inactive enrollment
Examples:
canvas enrollments create --course-id 123 --user-id 456
canvas enrollments create --course-id 123 --user-id 456 --type TeacherEnrollment
canvas enrollments create --course-id 123 --user-id 456 --state active --notify
canvas enrollments create --course-id 123 --user-id 456 --section-id 789
Options¶
--course-id int Course ID (required)
-h, --help help for create
--notify Send enrollment notification email
--role string Custom role name
--section-id int Section ID
--state string Initial enrollment state (active, invited)
--type string Enrollment type (default "StudentEnrollment")
--user-id int User ID to enroll (required)
Options inherited from parent commands¶
--as-user int Masquerade as another user (admin feature, requires permission)
--columns strings Select specific columns to display (comma-separated)
--config string config file (default is $HOME/.canvas-cli/config.yaml)
--dry-run Print curl commands instead of executing requests
--filter string Filter results by text (case-insensitive substring match)
--instance string Canvas instance URL (overrides config)
--limit int Limit number of results for list operations (0 = unlimited)
--no-cache Disable caching of API responses
-o, --output string Output format: table, json, yaml, csv (default "table")
--show-token Show actual token in dry-run output (default: redacted)
--sort string Sort results by field (prefix with - for descending, e.g., -name)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas enrollments - Manage Canvas enrollments