ABCDEFGHIJKLMNOPQRSTUVWXYZAA
1
2
For APIv4 specification, see https://docs.google.com/document/d/197JwEBMnK8okFilTfGSpbsrXPY5RZOJ4gG2DXwcbwYE/edit
3
4
5
Color codesCompletedIn progressNot started
6
7
User Endpoints (see tabs at bottom for more sections)
8
9
METHODENDPOINTDESCRIPTIONREQUEST BODYQUERY PARAMETERSRESPONSEPERMISSIONCONTRIBUTORLINK TO PR
10
POST/usersCreate a user.UserUserjwilander
https://github.com/mattermost/platform/pull/5191
3.7
11
PUT/users/{user_id}Update a user.UserUserSelf or "edit_other_users"jwilander
https://github.com/mattermost/platform/pull/5191
3.7
12
PUT/users/{user_id}/patchPartially update a user.Partial userUserSelf or "edit_other_users"jwilander
https://github.com/mattermost/platform/pull/5418
3.7
13
PUT/users/{user_id}/rolesUpdate a user's roles.RolesOK"manage_roles"jwilander
https://github.com/mattermost/platform/pull/5238
3.7
14
PUT/users/{user_id}/passwordUpdate a user's password.Current password, old passwordOKSelf or "manage_system"jwilander
https://github.com/mattermost/platform/pull/5243
3.7
15
POST/users/password/resetReset a user's password.Recovery code, new passwordOK
None, but must include vaild recovery code
jwilander
https://github.com/mattermost/platform/pull/5256
3.7
16
POST/users/password/reset/sendSend a reset password email to a user.EmailOKjwilander
https://github.com/mattermost/platform/pull/5256
3.7
17
GET/usersGet a page of users as an array.page
per_page
in_channel
in_team
not_in_channel		User listLogged injwilander
https://github.com/mattermost/platform/pull/5277
3.7
18
GET/users/{user_id}Get a single user.UserLogged injwilander
https://github.com/mattermost/platform/pull/5191
3.7
19
GET/users/username/{username}Get a user by username.UserLogged inruzette
https://github.com/mattermost/platform/pull/5310
3.7
20
GET/users/email/{email}Get a user by email.UserLogged inruzette
https://github.com/mattermost/platform/pull/5309
3.7
21
POST/users/idsGet a list of users matching the provided ids.List of user idsUser listLogged injwilander
https://github.com/mattermost/platform/pull/5274
3.7
22
POST/users/searchGet a list of users based on search criteria provided in the request body.UserSearchUser listLogged injwilander
https://github.com/mattermost/platform/pull/5822
3.8
23
GET/users/autocompleteGet a list of users for the purpose of autocompleting based on the provided term.name
in_channel
in_team
User listLogged injwilander
https://github.com/mattermost/platform/pull/5742
3.8
24
POST/users/{user_id}/email/verifyVerify a user's email address.user_id
hash		OK
None, but hash must match user id + salt
cpanato
https://github.com/mattermost/platform/pull/5502
3.7
25
POST/users/email/verify/sendSend a verification email to a user.EmailOKjwilander
https://github.com/mattermost/platform/pull/5825
3.8
26
POST/users/{user_id}/imageUpload a profile image for a user.Multipart formOKSelf, or "edit_other_users"saturninoabril
https://github.com/mattermost/platform/pull/5537
3.7
27
GET/users/{user_id}/imageGet a user's profile image.Image bytesLogged insaturninoabril
https://github.com/mattermost/platform/pull/5526
3.7
28
POST/users/loginLog a user in.Userjwilander
https://github.com/mattermost/platform/pull/5191
3.7
29
POST/users/logoutLog a user out.OKjwilander
https://github.com/mattermost/platform/pull/5191
3.7
30
POST/users/login/switchSwitch a user's login types.Info about type to switch toOKjwilander
https://github.com/mattermost/platform/pull/6000
3.9
31
GET/users/{user_id}/sessionsGet a list of sessions for a user.Session listSelf, or "edit_other_users"ruzette
https://github.com/mattermost/platform/pull/5449
3.7
32
POST/users/{user_id}/sessions/revokeRevoke a session for a user.Session idOKSelf, or "edit_other_users"ruzette
https://github.com/mattermost/platform/pull/5449
3.7
33
GET/users/{user_id}/auditsGet a list of audits for a user.Audit listSelf, or "edit_other_users"saturninoabril
https://github.com/mattermost/platform/pull/5472
3.7
34
PUT/users/sessions/deviceAttach a user's mobile device ID to their current session.Device idOKSelfjwilander
https://github.com/mattermost/platform/pull/5866
3.8
35
POST/users/mfaGet whether a user has MFA activated.login_id
{
"mfa_required": bool
}
jwilander
https://github.com/mattermost/platform/pull/5864
3.8
36
PUT/users/{user_id}/mfaUpdate a user's MFA.Boolean for on/off, tokenOKSelf, or "edit_other_users"jwilander
https://github.com/mattermost/platform/pull/5743
3.8
37
POST/users/{user_id}/mfa/generateGenerate a new MFA secret for a user.{
"qr_code": string,
"secret": string
}		Logged injwilander
https://github.com/mattermost/platform/pull/5864
3.8
38
DELETE/users/{user_id}Deactivate a user account.OKSelf, or "edit_other_users"ruzette
https://github.com/mattermost/platform/pull/5307
3.7
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100