mattermost/server/cmd/mmctl/docs/mmctl_user_convert.rst
Miguel de la Cruz 951456c780
Includes mmctl into the mono-repo (#23091)
* Includes mmctl into the mono-repo

* Update to use the new public module paths

* Adds docs check to the mmctl CI

* Fix public utils import path

* Tidy up modules

* Fix linter

* Update CI tasks to use the new file structure

* Update CI references
2023-06-05 12:42:55 +02:00

68 lines
2.7 KiB
ReStructuredText

.. _mmctl_user_convert:
mmctl user convert
------------------
Convert users to bots, or a bot to a user
Synopsis
~~~~~~~~
Convert user accounts to bots or convert bots to user accounts.
::
mmctl user convert (--bot [emails] [usernames] [userIds] | --user <username> --password PASSWORD [--email EMAIL]) [flags]
Examples
~~~~~~~~
::
# you can convert a user to a bot providing its email, id or username
$ mmctl user convert user@example.com --bot
# or multiple users in one go
$ mmctl user convert user@example.com anotherUser --bot
# you can convert a bot to a user specifying the email and password that the user will have after conversion
$ mmctl user convert botusername --email new.email@email.com --password password --user
Options
~~~~~~~
::
--bot If supplied, convert users to bots
--email string The email address for the converted user account. Required when the "bot" flag is set
--firstname string The first name for the converted user account. Required when the "bot" flag is set
-h, --help help for convert
--lastname string The last name for the converted user account. Required when the "bot" flag is set
--locale string The locale (ex: en, fr) for converted new user account. Required when the "bot" flag is set
--nickname string The nickname for the converted user account. Required when the "bot" flag is set
--password string The password for converted new user account. Required when "user" flag is set
--system-admin If supplied, the converted user will be a system administrator. Defaults to false. Required when the "bot" flag is set
--user If supplied, convert a bot to a user
--username string Username for the converted user account. Required when the "bot" flag is set
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
--disable-pager disables paged output
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
--insecure-tls-version allows to use TLS versions 1.0 and 1.1
--json the output format will be in json format
--local allows communicating with the server through a unix socket
--quiet prevent mmctl to generate output for the commands
--strict will only run commands if the mmctl version matches the server one
--suppress-warnings disables printing warning messages
SEE ALSO
~~~~~~~~
* `mmctl user <mmctl_user.rst>`_ - Management of users