User:Zaycodes/Sandbox/API:Validatepassword/en
This page is part of the MediaWiki Action API documentation. |
POST request to validate password against wiki's password policies.
MediaWiki version: | ≥ 1.29 |
API documentation[edit]
action=validatepassword(main | validatepassword)
Validate a password against the wiki's password policies. Validity is reported as Good if the password is acceptable, Change if the password may be used for login but must be changed, or Invalid if the password is not usable. Specific parameters: Other general parameters are available.
Examples:
|
Example[edit]
POST Request[edit]
Validate a password against the wiki's password policies.
Response[edit]
{
"validatepassword": {
"validity": "Good"
}
}
Sample code[edit]
Python[edit]
#!/usr/bin/python3
"""
validatepassword.py
MediaWiki Action API Code Samples
Demo of `Validatepassword` module: Validate a password against the wiki's password policies.
MIT license
"""
import requests
URL = "https://en.wikipedia.org/w/api.php"
S = requests.Session()
PARAMS = {
"action": "validatepassword",
"format": "json",
"password": "",
}
R = S.post(URL, data=PARAMS)
DATA = R.json()
print(DATA)
PHP[edit]
<?php
/*
validatepassword.php
MediaWiki Action API Code Samples
Demo of `Validatepassword` module: Validate a password against the wiki's password policies.
MIT license
"""
*/
$endPoint = "https://en.wikipedia.org/w/api.php";
$validate_password = validatePassword();
function validatePassword() {
global $endPoint;
$params = [
"action" => "validatepassword",
"password" => "my_password",
"format" => "json"
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endPoint );
curl_setopt( $ch, CURLOPT_POST, true );
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params ) );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
}
JavaScript[edit]
/*
validatepassword.js
MediaWiki Action API Code Samples
Demo of `Validatepassword` module: Validate a password against the wiki's password policies.
MIT license
*/
var request = require("request").defaults({jar: true}),
url = 'https://en.wikipedia.org/w/api.php';
function validatePassword() {
var params = {
action: "validatepassword",
password: "your_password",
format: "json"
};
request.post({ url: url, form: params }, function (error, res, body) {
if (error) {
return;
}
console.log(body);
});
}
MediaWiki JS[edit]
/*
validatepassword.js
MediaWiki Action API Code Samples
Demo of `Validatepassword` module: Validate a password against the wiki's password policies.
MIT license
*/
var params = {
action: "validatepassword",
password: "my_password",
format: "json"
},
api = new mw.Api();
api.postWithToken( 'csrf', params ).done( function ( data ) {
console.log( data );
} );
Possible errors[edit]
Code | Info |
---|---|
userexists | Username entered already in use. Please choose a different name. |
nopassword | The "password" parameter must be set. |
Additional notes[edit]
- Validity is reported as
Good
if the password is acceptable,Change
if the password may be used for login but must be changed, orInvalid
if the password is not usable.