POST /me/settings/password/validate

Verify strength of a user's new password.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/me/settings/password/validate
Requires authentication? Yes

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.

Request Parameters

Parameter Type Description
password (string) The users's potential new password.

Response Parameters

Parameter Type Description
passed (bool) Whether password validated or not.
test_results (string)
passed:
(array) Array of test name and test explanation.
failed:
(array) Array of test name and test explanation.

Resource Errors

This endpoint does not return any errors.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode '0=password = 1234' \
 'https://public-api.wordpress.com/rest/v1.1/me/settings/password/validate'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
      1 => 'Content-Type: application/x-www-form-urlencoded',
    ),
    'content' => 
     http_build_query(  array (
        0 => 'password = 1234',
      )),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1.1/me/settings/password/validate',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "passed": false,
    "test_results": {
        "passed": [
            {
                "test_name": "no_backslashes"
            }
        ],
        "failed": [
            {
                "test_name": "minimum_length",
                "explanation": "Password must be at least 6 characters."
            }
        ]
    }
}