Skip to content

Commit

Permalink
DOC-7643: Document how to manage teams via the System Console
Browse files Browse the repository at this point in the history
  • Loading branch information
Rutam21 committed Dec 10, 2024
1 parent 1241ed9 commit 01913dc
Show file tree
Hide file tree
Showing 10 changed files with 114 additions and 13 deletions.
127 changes: 114 additions & 13 deletions source/configure/user-management-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,6 @@ View user profile details using the System Console. Gather information including
.. image:: ../images/user-profile-details.png
:alt: Review user details using the System Console



----

Groups
Expand Down Expand Up @@ -255,26 +253,129 @@ Teams

<p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E20</p>

+---------------------------------------------------------------+-------------------------------------------------------------+
| Manage team settings, including group synchronization for | - System Config path: **User Management > Teams** |
| teams. | - ``config.json setting``: N/A |
| | - Environment variable: N/A |
+---------------------------------------------------------------+-------------------------------------------------------------+
Find Teams
~~~~~~~~~~

Archive the team
~~~~~~~~~~~~~~~~~
You can find a team using the System Console.

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Type the name of the team in the **Search** box to find the particular team, if it exists.

.. image:: ../images/find-teams.png
:alt: Find a Mattermost team using the System Console.

.. tip::

From Mattermost v9.6, you can:

- Search for specific teams by entering a partial or full team name in the **Search** field and pressing :kbd:`Enter`.

Filter team searches
~~~~~~~~~~~~~~~~~~~~

You can filter System Console team search to narrow down results based on the team membership type i.e., 'Anyone Can Join', 'Invite Only' or 'Group Sync'.

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select **Filters** located to the right of the **Search** field to access available filter options.
3. Choose any filter and select **Apply** to filter team search results.

.. image:: ../images/team-search-filters.png
:alt: Filter the teams based on team membership types using the System Console.

Review team configuration
~~~~~~~~~~~~~~~~~~~~~~~~~

View team configuration details using the System Console. Gather information including the team name, team description, team mangement options, groups and members.

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select the team from the list, and browse team configuration details.

See the :ref:`archive a team <collaborate/organize-using-teams:archive a team>` documentation for details on archiving teams that are no longer needed.
.. image:: ../images/team-configuration-details.png
:alt: Review team configuration details using the System Console

Manage team membership
~~~~~~~~~~~~~~~~~~~~~~

Admins can directly add or remove member from the team. They can also customize how members are added to the team using the System Console.

Add members
^^^^^^^^^^^

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select the team from the list and tap on it to view its configuration page.
3. In the **Members** section, tap on **Add Members**.
4. Select an user or available bot from the list or try using the **Search** to find a specific one.
5. Click on **Add** to add the user or bot.
6. Click on **Save** to save the changes to the team.

.. image:: ../images/add-members-to-a-team.png
:alt: Add a member to the team using the System Console.

Remove members
^^^^^^^^^^^^^^

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select the team from the list and tap on it to view its configuration page.
3. In the **Members** section, tap on **Remove** for the user or bot that you want to remove.
4. Click on **Save** to save the changes to the team.

.. image:: ../images/remove-members-from-a-team.png
:alt: Remove a member from the team using the System Console.

Sync group members
^^^^^^^^^^^^^^^^^^

When enabled, adding and removing users from groups will add or remove them from this team. The only way of inviting members to this team is by adding the groups they belong to. See the :ref:`Synchronize teams and channels <onboard/ad-ldap-groups-synchronization:synchronize teams and channels>` documentation for further details.

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select the team from the list and tap on it to view its configuration page.
3. In the **Team Management** section, enable the **Sync Group Members** option.
4. Click on **Save** to save the changes to the team.

.. image:: ../images/sync-group-members-in-a-team.png
:alt: Enable Sync Group Members for a team using the System Console.

Anyone can join this team
^^^^^^^^^^^^^^^^^^^^^^^^^

This team can be discovered allowing anyone with an account to join this team.

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select the team from the list and tap on it to view its configuration page.
3. In the **Team Management** section, enable the **Anyone can join this team** option.
4. Click on **Save** to save the changes to the team.

.. image:: ../images/anyone-can-join-a-team.png
:alt: Enable Anyone can join this team option for a team using the System Console.

Only specific email domains can join this team
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Users can only join the team if their email matches one of the specified domains.

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select the team from the list and tap on it to view its configuration page.
3. In the **Team Management** section, enable the **Only specific email domains can join this team** option.
4. Click on **Save** to save the changes to the team.

.. image:: ../images/specific-email-domains-can-join-a-team.png
:alt: Enable Only specific email domains can join this team option for a team using the System Console.

Synchronize team members
~~~~~~~~~~~~~~~~~~~~~~~~~

Admins can choose between inviting members to a team manually or synchronizing members automatically from AD/LDAP groups. See the :ref:`using AD/LDAP synchronized groups <onboard/ad-ldap-groups-synchronization:synchronize ad/ldap groups to mattermost>` documentation for details on managing team or private channel membership.

Who can join the team?
~~~~~~~~~~~~~~~~~~~~~~~~
Archive the team
~~~~~~~~~~~~~~~~

1. Go to **System Console > User Management > Teams** to access all available teams.
2. Select the team from the list and tap on it to view its configuration page.
3. In the **Team Profile** section, tap on **Archive Team**.
4. Click on **Save** to save the changes to the team.

Admins can choose to make the team discoverable by allowing anyone with an account to join the team. Alternatively admins can enable specific email domains to join the team.
.. image:: ../images/archive-a-team.png
:alt: Archive a team using the System Console.

----

Expand Down
Binary file added source/images/add-members-to-a-team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/anyone-can-join-a-team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/archive-a-team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/find-teams.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/remove-members-from-a-team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/sync-group-members-in-a-team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/team-configuration-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/team-search-filters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 01913dc

Please sign in to comment.