Skip to content

user:cancel

Block or delete user account(s) with the specified name(s).

Examples

  • user:cancel alice
  • user:cancel --delete-content alice
  • user:cancel --reassign-content --uid=12

Arguments

  • [names]. A comma delimited list of user names.

Options

  • --uid=UID. A comma delimited list of user ids to lookup (an alternative to names).
  • --mail=MAIL. A comma delimited list of emails to lookup (an alternative to names).
  • --reassign-content. Delete the user and make its content belong to the anonymous user.
  • --delete-content. Delete the user, and delete all content created by that user.

Global Options

  • -h, --help. Display help for the given command. When no command is given display help for the list command
  • --silent. Do not output any message
  • -q, --quiet. Only errors are displayed. All other output is suppressed
  • -v|vv|vvv, --verbose. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • -V, --version. Display this application version
  • --ansi. Force (or disable --no-ansi) ANSI output
  • --no-ansi. Negate the --ansi option.
  • -n, --no-interaction. Do not ask any interactive question
  • --url=URL. A base URL (e.g. example.com). Used for building links, selecting a multi-site, etc.
  • -e, --env=ENV. The Environment name. [default: prod]
  • --no-debug. Switches off debug mode.

Aliases

  • ucan
  • user-cancel

Legend

  • An argument or option with square brackets is optional.
  • Any default value is listed at end of arg/option description.
  • An ellipsis indicates that an argument accepts multiple values separated by a space.