Files
mostlymatter/server/cmd/mmctl/docs/mmctl_user_migrate-auth.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

55 строки
1.8 KiB
ReStructuredText

.. _mmctl_user_migrate-auth:
mmctl user migrate-auth
-----------------------
Mass migrate user accounts authentication type
Synopsis
~~~~~~~~
Migrates accounts from one authentication provider to another. For example, you can upgrade your authentication provider from email to ldap.
::
mmctl user migrate-auth [from_auth] [to_auth] [migration-options] [flags]
Examples
~~~~~~~~
::
user migrate-auth email saml users.json
Options
~~~~~~~
::
--auto Automatically migrate all users. Assumes the usernames and emails are identical between Mattermost and SAML services. (saml only)
--confirm Confirm you really want to proceed with auto migration. (saml only)
--force Force the migration to occur even if there are duplicates on the LDAP server. Duplicates will not be migrated. (ldap only)
-h, --help help for migrate-auth
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