User management configuration settings#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

Manage your Mattermost users including their access permissions, groups, teams, channels, as well as their access to the System Console. Configure this feature in the System Console by going to User Management:


Users#

Also available in legacy Mattermost Enterprise Edition E10 or E20

Getting people set up with a Mattermost account is typically something that system admins do when deploying and configuring the Mattermost workspace. A Mattermost admin can provision Mattermost users using one or more of the following methods:

Manage activated and deactivated users, revoke all user sessions, access individual users to view their User ID, add users to other teams, and view the teams they are on, and what their role is on a team.

  • System Config path: User Management > Users

  • config.json setting: N/A

  • Environment variable: N/A

Note: You can search for users by partial first name, last name, nickname, or username.

Identify a User’s ID#

Users can be specified in Mattermost by username or user ID. Usernames automatically resolve when a match is detected. System admins can identify a user’s ID using the Mattermost API or mmctl.

Use the System Console#

Go to System Console > User Management > Users to access all user accounts. Select a user to review their ID.

Tip

From Mattermost v9.6, you can:

  • Customize this page by showing or hiding user details, including email address, member duration, last login, activity, or post, number of days active (PostgreSQL only), and number of messages posted (PostgreSQL only). You can also control how many user records display on the page at a time.

  • Search for specific users by entering a partial or full username, first name, last name, or email address in the Search field and pressing Enter.

  • Filter users by team, role, or status.

  • Filter users by activity timeframes, including the last 30 days, the previous month, and the last 6 months.

  • Mattermost Enterprise and Professional customers can also export user data as a CSV report. You’ll receive the report as a direct message in Mattermost.

Use the API#

Use the API when you want to automate user-related tasks, or integrate with external systems.

Make an HTTP GET request to the following endpoint: https://your-mattermost-url/api/v4/users/username/username_here. Replace your-mattermost-url with the URL of your Mattermost instance and username_here with the username you are looking for.

The API response contains a JSON object that includes the user’s ID among other details.

Use mmctl#

If you prefer command-line tools, Mattermost offers mmctl for system administration.

In a terminal window, use the following command to list all users and their IDs: mmctl user list to return a list of user IDs.

Deactivate user accounts#

If you need to remove a user from your Mattermost deployment, you can deactivate the user account. Deactivated users have an deactivated status, are logged out of Mattermost as soon as they are deactivated, and deactivated users can no longer log back in. While a user account is deactivated, you can manage the user’s role, password, and email address.

Deactivate a user account by selecting a user, then selecting Deactivate. You can re-activate that user account later by selecting Activate.


Groups#

Also available in legacy Mattermost Enterprise Edition E20

Manage default teams and channels by linking AD/LDAP groups to Mattermost groups.

  • System Config path: User Management > Groups

  • config.json setting: N/A

  • Environment variable: N/A

See the AD/LDAP groups documentation for details.


Teams#

Also available in legacy Mattermost Enterprise Edition E20

Manage team settings, including group synchronization for teams.

  • System Config path: User Management > Teams

  • config.json setting: N/A

  • Environment variable: N/A

See the using AD/LDAP synchronized groups to manage team or private channel membership documentation for details.


Channels#

Also available in legacy Mattermost Enterprise Edition E20

Manage channel settings, including group synchronization on channels.

  • System Config path: User Management > Channels

  • config.json setting: N/A

  • Environment variable: N/A

Notes:

  • Channels can be deleted with all content, including posts in the database, using the mmctl channel delete tool.

  • You can search for channels by channel name or by channel ID.


Permissions#

Note

plans-img-yellow Available only on Enterprise and Professional plans

Also available in legacy Mattermost Enterprise Edition E10 or E20

Restrict actions in Mattermost to authorized users only.

  • System Config path: User Management > Permissions

  • config.json setting: N/A

  • Environment variable: N/A

See advanced permissions documentation for details


System roles#

Also available in legacy Mattermost Enterprise Edition E10 or E20

Restrict System Console access to authorized users only.

  • System Config path: User Management > System Roles

  • config.json setting: N/A

  • Environment variable: N/A

See additional system admin roles documentation for details