User:Evigian/Sandbox/API:Validatepassword

MediaWiki version:

≥ 1.23

API documentation

action=validatepassword (main | validatepassword) This module requires read rights. This module only accepts POST requests. Source: MediaWiki License: GPL-2.0-or-later 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. https://www.mediawiki.org/wiki/Special:MyLanguage/API:Validatepassword Specific parameters: Other general parameters are available. password Password to validate. This parameter is required. user Username, for use when testing account creation. The named user must not exist. Type: user, by any of username and user ID (e.g. "#12345") email Email address, for use when testing account creation. realname Real name, for use when testing account creation. Examples: Validate the password foobar for the current user. api.php?action=validatepassword&password=foobar [open in sandbox] Validate the password qwerty for creating user Example. api.php?action=validatepassword&password=querty&user=Example [open in sandbox]

Example

POST request

Description of script

api.php?action=validatepassword&format=json&password= [try in ApiSandbox]

Response

{
    "validatepassword": {
        "validity": "Change",
        "validitymessages": [
            {
                "message": "passwordtooshort",
                "params": [
                    8
                ],
                "code": "passwordtooshort",
                "type": "error"
            },
            {
                "message": "passwordinlargeblacklist",
                "params": [],
                "code": "passwordinlargeblacklist",
                "type": "error"
            }
        ]
    }
}

Sample code

Python

#!/usr/bin/python3

"""
    validatepassword.py

    MediaWiki Action API Code Samples
    Demo of `validate password` 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": "your_password",
}

R = S.post(URL, data=PARAMS)
DATA = R.json()

print(DATA)

PHP

<?php

/*
    validatepassword.php

    MediaWiki Action API Code Samples
    Demo of `validate password` module: Validate a password against the wiki's password policies.
    MIT license
"""
*/

<?php

$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

/*
    validatepassword.js

    MediaWiki Action API Code Samples
    Demo of `validate password` 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

/*
    validatepassword.js

    MediaWiki Action API Code Samples
    Demo of `validate password` 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 );
} );

Demo app(s)

• Add a link to the demo app. Embed an image of the demo if applicable

Possible errors

Code	Info
Error: 403	Insecure Request Forbidden - use HTTPS.
nopassword	The "password" parameter must be set.
mustpostparams	The following parameter was found in the query string, but must be in the POST body: password.
userexists	Username entered already in use. Please choose a different name.

Parameter history

• v1.x: Introduced parameter_1, parameter_2
• v0.x: Deprecated parameter_3

See also

• Add link to documentation of related modules