MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=resetpassword
(main | resetpassword)
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Send a password reset email to a user.
Parameters:
- user
User being reset.
- Type: user name
Email address of the user being reset.
- capture
Return the temporary passwords that were sent. Requires the
passwordreset
user right.- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
Examples:
- Send a password reset email to user Example.
- api.php?action=resetpassword&user=Example&token=123ABC [open in sandbox]
- Send a password reset email for all users with email address user@example.com.
- api.php?action=resetpassword&user=user@example.com&token=123ABC [open in sandbox]