Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Check a user's password against the organization's password validation policy and report whether the password is valid. Use this action to provide real-time feedback on password strength while the user types their password.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
User.ReadWrite |
User.ReadWrite.All |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
Not supported. |
Not supported. |
Important
This API operation doesn't require the calling user to be assigned any Microsoft Entra admin roles.
HTTP request
POST /users/validatePassword
Request body
In the request body, supply JSON representation of the parameters.
The following table shows the parameters that are required with this action.
| Parameter |
Type |
Description |
| password |
String |
The password to be validated by this action. |
Response
If successful, this action returns a 200 OK response code and a passwordValidationInformation object in the response body.
Examples
Request
POST https://graph.microsoft.com/beta/users/validatePassword
Content-Type: application/json
{
"password": "1234567890"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Users.ValidatePassword;
var requestBody = new ValidatePasswordPostRequestBody
{
Password = "1234567890",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users.ValidatePassword.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
//other-imports
)
requestBody := graphusers.NewValidatePasswordPostRequestBody()
password := "1234567890"
requestBody.SetPassword(&password)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
validatePassword, err := graphClient.Users().ValidatePassword().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.users.validatepassword.ValidatePasswordPostRequestBody validatePasswordPostRequestBody = new com.microsoft.graph.beta.users.validatepassword.ValidatePasswordPostRequestBody();
validatePasswordPostRequestBody.setPassword("1234567890");
var result = graphClient.users().validatePassword().post(validatePasswordPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const passwordValidationInformation = {
password: '1234567890'
};
await client.api('/users/validatePassword')
.version('beta')
.post(passwordValidationInformation);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\ValidatePassword\ValidatePasswordPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ValidatePasswordPostRequestBody();
$requestBody->setPassword('1234567890');
$result = $graphServiceClient->users()->validatePassword()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Users.Actions
$params = @{
password = "1234567890"
}
Test-MgBetaUserPassword -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.validate_password.validate_password_post_request_body import ValidatePasswordPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ValidatePasswordPostRequestBody(
password = "1234567890",
)
result = await graph_client.users.validate_password.post(request_body)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#users/$entity",
"isValid": false,
"validationResults": [
{
"ruleName": "password_not_meet_complexity",
"validationPassed": false,
"message": "Password does not meet complexity requirements."
}
]
}