Mattermost-server: [Help Wanted] [PLT-7395] Add the ability to search users by role in System Console > Users

[esethna]

If you're interested please comment here and come join our "Contributors" community channel on our daily build server, where you can discuss questions with community members and the Mattermost core team. For technical advice or questions, please join our "Developers" community channel.

New contributors please see our Developer's Guide, specifically for machine setup and for developer workflow.

---

Notes: Jira ticket

Proposed change:

Add a "Role" filter next to "Team" with the following options

• "All Roles" (default, searches everyone)
• "Inactive" (filters users who have been deactivated)
• "User with Access Token Permission" (filters users who have permissions to generate an access token. This option is only shown if System Console > Integrations > Custom Integrations > Enable Personal Access Tokens is set to "true")
• "System Admin" (filters users who are system admins)
• "Member" (filters users who are members)

[Zapix]

Hi. I've looked through api v4 for users and search. There isn't query param for filtering by role or another way to implement this. Should be api updated for this ticket?

[jasonblais]

@Zapix Excellent question. Looks like you're already signed up to https://pre-release.mattermost.com, would you like to post your question in the APIv4 channel?

(I would say yes, but a developer will be able to confirm it in the channel)

[jwilander]

Added Go label as this will require updates to the server API for querying based on role

[jasonblais]

@Zapix If you're interested to learn Go or to add a new APIv4 endpoint, we have documentation here that guides you through the process (plus you're welcome to ask questions): https://docs.mattermost.com/developer/api4.html

However, feel free to pick another Hacktoberfest issue too if you'd prefer :)

[jwilander]

For more information, it will likely require a new database query or two, corresponding app layer functions and would be an addition to the POST /api/v4/users/search and GET /api/v4/users endpoints

[Zapix]

@jasonblais Thank you. I'll try to work on this issue on weekends I think.

[jasonblais]

@Zapix Let us know if you have any questions on this ticket?

[jkurian]

Hey! Is this issue still open / valid?

[jasonblais]

It is! Would you be interested helping with this improvement @jkurian?

[jkurian]

Yes! I will gladly take this ticket.

[jasonblais]

That would be great! Removing Up For Grabs label

[jasonblais]

Hey @jkurian - just checking how things are going and if you have any questions?

[jkurian]

Hi @jasonblais, sorry I have been swamped with work and I don't see it clearing up anytime soon. Maybe a good idea to open this back up to the public?

[jasonblais]

Thanks @jkurian! Sounds good, we've added the "Up For Grabs" label back.

[pradeepmurugesan]

I would take this one, if its still valid

[jasonblais]

That would be great! It is still open.

Thank you @pradeepmurugesan 🎉

[pradeepmurugesan]

Waiting for clarification - https://pre-release.mattermost.com/core/pl/y765b8tdaffbucqtxg7mw6tm7h