* add support for get/set/delete user preferences

* make mmctl-docs

* make --category required

---------

Co-authored-by: Mattermost Build <build@mattermost.com>
Этот коммит содержится в:
Jesse Hallam
2024-02-07 15:34:37 -04:00
коммит произвёл GitHub
родитель 495245b43e
Коммит ec1c693df9
10 изменённых файлов: 1026 добавлений и 0 удалений

Просмотреть файл

@@ -49,6 +49,7 @@ SEE ALSO
* `mmctl user invite <mmctl_user_invite.rst>`_ - Send user an email invite to a team.
* `mmctl user list <mmctl_user_list.rst>`_ - List users
* `mmctl user migrate-auth <mmctl_user_migrate-auth.rst>`_ - Mass migrate user accounts authentication type
* `mmctl user preference <mmctl_user_preference.rst>`_ - Manage user preferences
* `mmctl user promote <mmctl_user_promote.rst>`_ - Promote guests to users
* `mmctl user reset-password <mmctl_user_reset-password.rst>`_ - Send users an email to reset their password
* `mmctl user resetmfa <mmctl_user_resetmfa.rst>`_ - Turn off MFA

Просмотреть файл

@@ -0,0 +1,44 @@
.. _mmctl_user_preference:
mmctl user preference
---------------------
Manage user preferences
Synopsis
~~~~~~~~
Manage user preferences
Options
~~~~~~~
::
-h, --help help for preference
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 preference delete <mmctl_user_preference_delete.rst>`_ - Delete a specific user preference
* `mmctl user preference get <mmctl_user_preference_get.rst>`_ - Get a specific user preference
* `mmctl user preference list <mmctl_user_preference_list.rst>`_ - List user preferences
* `mmctl user preference set <mmctl_user_preference_set.rst>`_ - Set a specific user preference

Просмотреть файл

@@ -0,0 +1,53 @@
.. _mmctl_user_preference_delete:
mmctl user preference delete
----------------------------
Delete a specific user preference
Synopsis
~~~~~~~~
Delete a specific user preference
::
mmctl user preference delete --category [category] --name [name] [users] [flags]
Examples
~~~~~~~~
::
preference delete --category display_settings --name use_military_time user@example.com
Options
~~~~~~~
::
-c, --category string The category of the preference
-h, --help help for delete
-n, --name string The name of the preference
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 preference <mmctl_user_preference.rst>`_ - Manage user preferences

Просмотреть файл

@@ -0,0 +1,53 @@
.. _mmctl_user_preference_get:
mmctl user preference get
-------------------------
Get a specific user preference
Synopsis
~~~~~~~~
Get a specific user preference
::
mmctl user preference get --category [category] --name [name] [users] [flags]
Examples
~~~~~~~~
::
preference get --category display_settings --name use_military_time user@example.com
Options
~~~~~~~
::
-c, --category string The category of the preference
-h, --help help for get
-n, --name string The name of the preference
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 preference <mmctl_user_preference.rst>`_ - Manage user preferences

Просмотреть файл

@@ -0,0 +1,52 @@
.. _mmctl_user_preference_list:
mmctl user preference list
--------------------------
List user preferences
Synopsis
~~~~~~~~
List user preferences
::
mmctl user preference list [--category category] [users] [flags]
Examples
~~~~~~~~
::
preference list user@example.com
Options
~~~~~~~
::
-c, --category string The optional category by which to filter
-h, --help help for list
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 preference <mmctl_user_preference.rst>`_ - Manage user preferences

Просмотреть файл

@@ -0,0 +1,54 @@
.. _mmctl_user_preference_set:
mmctl user preference set
-------------------------
Set a specific user preference
Synopsis
~~~~~~~~
Set a specific user preference
::
mmctl user preference set --category [category] --name [name] --value [value] [users] [flags]
Examples
~~~~~~~~
::
preference set --category display_settings --name use_military_time --value true user@example.com
Options
~~~~~~~
::
-c, --category string The category of the preference
-h, --help help for set
-n, --name string The name of the preference
-v, --value string The value of the preference
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 preference <mmctl_user_preference.rst>`_ - Manage user preferences