/
DI
discourse
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Backups
4
Badges
6
Categories
5
Events
2
Groups
9
Invites
2
Notifications
2
Posts
8
Private Messages
2
Search
1
Site
2
Tags
6
Topics
14
Uploads
7
Users
25
post
/users.json
Creates a user
get
/u/{username}.json
Get a single user by username
put
/u/{username}.json
Update a user
get
/u/by-external/{external_id}.json
Get a user by external_id
get
/u/by-external/{provider}/{external_id}.json
Get a user by identity provider external ID
put
/u/{username}/preferences/avatar/pick.json
Update avatar
put
/u/{username}/preferences/email.json
Update email
put
/u/{username}/preferences/username.json
Update username
get
/directory_items.json
Get a public list of users
get
/admin/users/{id}.json
Get a user by id
delete
/admin/users/{id}.json
Delete a user
put
/admin/users/{id}/activate.json
Activate a user
put
/admin/users/{id}/deactivate.json
Deactivate a user
put
/admin/users/{id}/suspend.json
Suspend a user
put
/admin/users/{id}/silence.json
Silence a user
put
/admin/users/{id}/anonymize.json
Anonymize a user
post
/admin/users/{id}/merge.json
Merge a user
post
/admin/users/{id}/log_out.json
Log a user out
post
/user_avatar/{username}/refresh_gravatar.json
Refresh gravatar
get
/admin/users.json
List users
get
/admin/users/list/{flag}.json
List users by flag
get
/user_actions.json
Get a list of user actions
post
/session/forgot_password.json
Send password reset email
put
/users/password-reset/{token}.json
Change password
get
/u/{username}/emails.json
Get email addresses belonging to a user
Users
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Send password reset email
Changed on
Mar 5, 2022
post
/session/forgot_password.json
Request
Base URL
https://discourse.example.com
Auth
none declared
Request body
object
required
login
string
required
Response
200
OK
success response
object
required
success
string
required
user_found
boolean
required
Changes
Mar 5, 2022
e1108b0434c0
Revision changes
info
endpoint added
Operation history