mattermost/server/cmd/mmctl/docs/mmctl_user_edit.rst
Ben Schumacher 24bb82e345
[MM-63593] Add mmctl user edit command (#31181)
* Add mmctl user edit command

* Add e2e tests

* Use right client method to update authdata

* implement local API endpoint

* Don't allow users to clear the authdata

* make mmctl-docs

* Fix casing

* Fix example

* make mmctl-docs

* Simplify error message

* Fix test

---------

Co-authored-by: Mattermost Build <build@mattermost.com>
2025-07-25 09:56:25 +02:00

43 lines
1.4 KiB
ReStructuredText

.. _mmctl_user_edit:
mmctl user edit
---------------
Edit user properties
Synopsis
~~~~~~~~
Edit user properties like username, email, or authdata.
Options
~~~~~~~
::
-h, --help help for edit
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
* `mmctl user edit authdata <mmctl_user_edit_authdata.rst>`_ - Edit user's authdata
* `mmctl user edit email <mmctl_user_edit_email.rst>`_ - Edit user's email
* `mmctl user edit username <mmctl_user_edit_username.rst>`_ - Edit user's username