--- title: User Account Unlock description: The POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}} endpoint is called by an administrator or an application to unlock a user's account. This operation uses the application/vnd.pingidentity.account.unlock+json custom media type as the content type in the request header. component: pingone-api page_id: pingone-api:platform:users/user-accounts/user-account-unlock canonical_url: https://developer.pingidentity.com/pingone-api/platform/users/user-accounts/user-account-unlock.html section_ids: prerequisites: Prerequisites headers: Headers example-request: Example Request example-response: Example Response --- # User Account Unlock ## ```none POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}} ``` The `POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}` endpoint is called by an administrator or an application to unlock a user's account. This operation uses the `application/vnd.pingidentity.account.unlock+json` custom media type as the content type in the request header. The sample shows the `POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}` operation to unlock an account for the user identified by the user ID and environment ID. This `POST` request does not require any attribute values in the request body. It returns a `200 OK` message when successful, generates a `USER.UNLOCKED` event, and resets the MFA lockout counter if the user's account was locked. ### Prerequisites * Refer to [Users](../../users.html) for important overview information. * Create a user to get a `userID`. Refer to [Create User](../users-1/create-user.html). Run [Read User or Users](../users-1/read-all-users.html) to find an existing user. ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/vnd.pingidentity.account.unlock+json ## ### 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}}' \ --header 'Content-Type: application/vnd.pingidentity.account.unlock+json' \ --header 'Authorization: Bearer {{accessToken}}' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Post); request.AddHeader("Content-Type", "application/vnd.pingidentity.account.unlock+json"); 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}}" 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.account.unlock+json") 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}} HTTP/1.1 Host: {{apiPath}} Content-Type: application/vnd.pingidentity.account.unlock+json Authorization: Bearer {{accessToken}} ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/vnd.pingidentity.account.unlock+json"); RequestBody body = RequestBody.create(mediaType, ""); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}") .method("POST", body) .addHeader("Content-Type", "application/vnd.pingidentity.account.unlock+json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/vnd.pingidentity.account.unlock+json", "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}}', 'headers': { 'Content-Type': 'application/vnd.pingidentity.account.unlock+json', 'Authorization': 'Bearer {{accessToken}}' } }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}" payload = {} headers = { 'Content-Type': 'application/vnd.pingidentity.account.unlock+json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Content-Type' => 'application/vnd.pingidentity.account.unlock+json', '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 "json" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/vnd.pingidentity.account.unlock+json" 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}}")!,timeoutInterval: Double.infinity) request.addValue("application/vnd.pingidentity.account.unlock+json", 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/f0a13f5d-3314-49c8-aede-86a059461728" }, "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "population": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/3c096844-4336-4fb2-8555-ce8cfe2c1acd" }, "devices": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/devices" }, "roleAssignments": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/roleAssignments" }, "password": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/password" }, "password.reset": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/password" }, "password.set": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/password" }, "password.check": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/password" }, "password.recover": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/password" }, "linkedAccounts": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/linkedAccounts" }, "account.sendVerificationCode": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728" }, "memberOfGroups": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/f0a13f5d-3314-49c8-aede-86a059461728/memberOfGroups" } }, "id": "f0a13f5d-3314-49c8-aede-86a059461728", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "account": { "canAuthenticate": true, "status": "OK" }, "createdAt": "2022-09-15T15:48:51.428Z", "email": "do-not-send@example.com", "enabled": true, "identityProvider": { "type": "PING_ONE" }, "lifecycle": { "status": "ACCOUNT_OK" }, "mfaEnabled": false, "name": { "given": "Test", "family": "CustomResourceUser" }, "population": { "id": "3c096844-4336-4fb2-8555-ce8cfe2c1acd" }, "updatedAt": "2022-09-15T15:49:29.368Z", "username": "CustomResource_user_1663256931", "verifyStatus": "NOT_INITIATED" } ```