--- title: Password Force Change description: Use the POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password operation to force a reset of the password identified by the user ID and environment ID without the administrator supplying a password. The header requires a content type of application/vnd.pingidentity.password.forceChange. The request body is empty. When this request successfully executes, the user's password status attribute value is changed to MUST_CHANGE_PASSWORD. The users existing password is unaffected. component: pingone-api page_id: pingone-api:platform:users/user-passwords/force-change-password canonical_url: https://developer.pingidentity.com/pingone-api/platform/users/user-passwords/force-change-password.html section_ids: prerequisites: Prerequisites headers: Headers example-request: Example Request example-response: Example Response --- # Password Force Change ## ```none POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password ``` Use the `POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password` operation to force a reset of the password identified by the user ID and environment ID without the administrator supplying a password. The header requires a content type of `application/vnd.pingidentity.password.forceChange`. The request body is empty. When this request successfully executes, the user's password `status` attribute value is changed to `MUST_CHANGE_PASSWORD`. The users existing password is unaffected. This operation doesn't allow for a self-change reset of the password. Instead, the user must change their password on their next sign on. | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | For an administrative reset, the password becomes unlocked, but other account lockout mechanisms are not unlocked. For example, if the account has been locked through an explicit `application/vnd.pingidentity.account.lock+json` request on the user, the account will still be locked after administrative reset. | When successful, it returns a `200 OK` message, generates a `USER.UNLOCKED` event, and resets the MFA lockout counter if the user's account was not already locked by MFA. ### Prerequisites * Refer to [Users](../../users.html) and [User Passwords](../user-passwords.html) for important overview information. ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/vnd.pingidentity.password.forceChange ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff --request POST '{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password' \ --header 'Content-Type: application/vnd.pingidentity.password.forceChange' \ --header 'Authorization: Bearer {{accessToken}}' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Post); request.AddHeader("Content-Type", "application/vnd.pingidentity.password.forceChange"); request.AddHeader("Authorization", "Bearer {{accessToken}}"); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password" method := "POST" client := &http.Client { } req, err := http.NewRequest(method, url, nil) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/vnd.pingidentity.password.forceChange") req.Header.Add("Authorization", "Bearer {{accessToken}}") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http POST /v1/environments/{{envID}}/users/{{userID}}/password HTTP/1.1 Host: {{apiPath}} Content-Type: application/vnd.pingidentity.password.forceChange Authorization: Bearer {{accessToken}} ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/vnd.pingidentity.password.forceChange"); RequestBody body = RequestBody.create(mediaType, ""); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password") .method("POST", body) .addHeader("Content-Type", "application/vnd.pingidentity.password.forceChange") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/vnd.pingidentity.password.forceChange", "Authorization": "Bearer {{accessToken}}" }, }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password', 'headers': { 'Content-Type': 'application/vnd.pingidentity.password.forceChange', 'Authorization': 'Bearer {{accessToken}}' } }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests url = "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password" payload = {} headers = { 'Content-Type': 'application/vnd.pingidentity.password.forceChange', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Content-Type' => 'application/vnd.pingidentity.password.forceChange', 'Authorization' => 'Bearer {{accessToken}}' )); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/vnd.pingidentity.password.forceChange" request["Authorization"] = "Bearer {{accessToken}}" response = http.request(request) puts response.read_body ``` ```swift var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/password")!,timeoutInterval: Double.infinity) request.addValue("application/vnd.pingidentity.password.forceChange", forHTTPHeaderField: "Content-Type") request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "POST" let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 200 OK ```json { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/6cbd9261-4ec4-4912-a219-d0f00e6096e2/password" }, "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "user": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/6cbd9261-4ec4-4912-a219-d0f00e6096e2" }, "passwordPolicy": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/passwordPolicies/a6f57fd8-0597-448c-8993-8bec226c38ef" }, "password.check": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/6cbd9261-4ec4-4912-a219-d0f00e6096e2/password" }, "password.reset": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/6cbd9261-4ec4-4912-a219-d0f00e6096e2/password" }, "password.set": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/6cbd9261-4ec4-4912-a219-d0f00e6096e2/password" }, "password.recover": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/6cbd9261-4ec4-4912-a219-d0f00e6096e2/password" } }, "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "user": { "id": "6cbd9261-4ec4-4912-a219-d0f00e6096e2" }, "passwordPolicy": { "id": "a6f57fd8-0597-448c-8993-8bec226c38ef" }, "status": "NO_PASSWORD", "lastChangedAt": "2022-05-04T12:33:09.853Z" } ```