canvas users update
canvas users update¶
Update an existing user
Synopsis¶
Update an existing user's information.
You can provide user data via flags or JSON file/stdin. Only specified fields will be updated.
Examples:
# Using flags
canvas users update 123 --name "John Smith"
canvas users update 123 --email "newemail@example.com" --timezone "America/New_York"
# Using JSON file
canvas users update 123 --json updates.json
# Using stdin
echo '{"name":"Updated Name"}' | canvas users update 123 --stdin
Options¶
--email string User's email address
-h, --help help for update
--json string JSON file with user data
--locale string User's locale (e.g., 'en')
--name string User's full name
--short-name string User's display name
--sortable-name string User's sortable name (e.g., 'Doe, John')
--stdin Read JSON from stdin
--timezone string User's timezone
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 users - Manage Canvas users