Skip to content

Document mmctl roles list (v11.7.0) #8965

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Combs7th wants to merge 2 commits into
base: master
Choose a base branch
from
+41 −0
Open

Document mmctl roles list (v11.7.0) #8965

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d26145
Document mmctl roles list (v11.7.0)
github-actions[bot] May 12, 2026
7e3c3ac
Merge branch 'master' into claude/issue-8964-20260512-2020
amyblais May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions source/administration-guide/manage/mmctl-command-line-tool.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5734,6 +5734,47 @@ Remove system admin privileges from multiple users:

**Options inherited from parent commands**

.. code-block:: sh

--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

mmctl roles list
~~~~~~~~~~~~~~~~

**Description**

From Mattermost v11.7.0, you can list all available roles and discover role names, such as ``system_admin`` or ``system_user``.

.. note::

This command requires system admin privileges, or `local mode <#local-mode>`__.
Comment on lines +5756 to +5758
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use an important admonition for this access prerequisite.

This block describes a hard requirement to run the command, so it should be elevated from .. note:: to .. important::.

Suggested minimal diff 
-.. note::
+.. important::

-   This command requires system admin privileges, or `local mode <#local-mode>`__.
+   This command requires system admin privileges, or `local mode <#local-mode>`__.

As per coding guidelines, "Use important admonition for prerequisites, constraints, or high-impact information that materially affects correctness, supportability, compliance, or success".

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@source/administration-guide/manage/mmctl-command-line-tool.rst` around lines
5753 - 5755, Replace the `.. note::` admonition used for the command access
prerequisite with an `.. important::` admonition so the requirement ("This
command requires system admin privileges, or `local mode <#local-mode>`__.") is
elevated; locate the block containing that text (the markdown/admonition
starting with `.. note::` and change the directive token to `.. important::`,
preserving the indented content and link text exactly.


**Format**

.. code-block:: sh

mmctl roles list [flags]

**Examples**

.. code-block:: sh

# List all available role names
$ mmctl roles list

# List all available role objects in JSON format
$ mmctl roles list --json

**Options inherited from parent commands**

.. code-block:: sh

--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
Expand Down
Loading