canvas temporary-enrollment-pairings
canvas temporary-enrollment-pairings¶
Manage Canvas temporary enrollment pairings
Synopsis¶
Manage temporary enrollment pairings for Canvas accounts.
Temporary enrollment pairings allow temporary instructors to be enrolled in courses for a limited time, inheriting permissions from a pairing configuration.
Examples:
canvas temporary-enrollment-pairings list 1
canvas temporary-enrollment-pairings get 1 5
canvas temporary-enrollment-pairings create 1 --enrollment-state active
canvas temporary-enrollment-pairings delete 1 5
Options¶
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 - Canvas LMS CLI - Interact with Canvas from the command line
- canvas temporary-enrollment-pairings create - Create a temporary enrollment pairing for an account
- canvas temporary-enrollment-pairings delete - Delete a temporary enrollment pairing
- canvas temporary-enrollment-pairings get - Get a specific temporary enrollment pairing
- canvas temporary-enrollment-pairings list - List temporary enrollment pairings for an account