canvas users

canvas users

Manage Canvas users

Synopsis

Manage Canvas users including listing, viewing, searching, and managing user information.

Examples:

canvas users list --account-id 1
canvas users get 123
canvas users search "john"
canvas users me

Options

  -h, --help   help for users

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 - Canvas LMS CLI - Interact with Canvas from the command line
• canvas users create - Create a new user (admin)
• canvas users get - Get details of a specific user
• canvas users list - List users in an account or course
• canvas users me - Get details of the current authenticated user
• canvas users search - Search for users
• canvas users update - Update an existing user

Auto generated by spf13/cobra on 25-Jan-2026