canvas enrollments conclude
canvas enrollments conclude¶
Conclude an enrollment
Synopsis¶
Conclude an enrollment (soft delete).
Tasks: conclude - Conclude the enrollment (default) deactivate - Mark enrollment as inactive delete - Permanently delete the enrollment
Examples:
canvas enrollments conclude 789 --course-id 123
canvas enrollments conclude 789 --course-id 123 --task deactivate
canvas enrollments conclude 789 --course-id 123 --task delete --force
Options¶
--course-id int Course ID (required)
--force Skip confirmation for delete
-h, --help help for conclude
--task string Task: conclude, deactivate, delete (default "conclude")
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