canvas audit list
canvas audit list¶
List audit log events
Synopsis¶
List Canvas audit log events. Use --type to select the audit category, then combine with a context flag to narrow the results.
Audit types: authentication — Login/logout events (use --account-id, --user-id, or --login-id) course — Course-change events (use --account-id or --course-id) grade-change — Grade-change events (use --course-id, --assignment-id, --grader-id, or --student-id)
Examples:
canvas audit list --type authentication --account-id 1
canvas audit list --type grade-change --course-id 123 --start-time 2024-01-01
Options¶
--account-id int Account ID (authentication/course audits)
--assignment-id int Assignment ID (grade-change audits)
--course-id int Course ID (course/grade-change audits)
--end-time string Filter events up to this time (ISO 8601)
--grader-id int Grader user ID (grade-change audits)
-h, --help help for list
--login-id int Login ID (authentication audits)
--per-page int Number of results per page
--start-time string Filter events from this time (ISO 8601)
--student-id int Student user ID (grade-change audits)
--type string Audit type: authentication, course, grade-change (default "grade-change")
--user-id int User ID (authentication audits)
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")
--quiet Suppress informational messages, only output data and errors
--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 audit - View Canvas audit logs