Reset Passwords

To call the API so that it performs the operations or returns the data requested by your application, you need to make a POST request to the appropriate endpoint. The below example demonstrates how to reset a person's password.

Endpoint

https://<YourEmpowerIDServer>/api/services/v1/password/reset

Headers

Key	Value
X-EmpowerID-API-Key	The API key for the OAuth application you registered in EmpowerID.
Authorization	The OAuth token you received from EmpowerID.
Content-Type	application/json

Request Data

Request data is sent to the API in JSON format. The data in the below request represents the minimum key/value pairs required for editing an EmpowerID Person.

{"Password":"Newp@$$w0rd","PersonID":184184,"UnlockAccounts":false,"MustChangePasswordOnNextLogin":false}

Element	Description	Type	Required / Optional	Note
Password	New password	String	Required
PersonID	ID of the target person	Integer	Required

Code Examples

cURL

Be sure to use double quotes unless you are making the request from a non-Windows OS.

Request

curl --location --request POST 'https://Your_Web_Server/api/services/v1/password/reset' \
--header 'Content-Type: application/json' \
--data-raw '{
  "Password": "<string>",  
  "PersonID": "<integer>"
}'

C#

var client = new RestClient("https://Your_Web_Server/api/services/v1/password/reset");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"Password\": \"<string>\",\n  \"PersonID\": \"<integer>\"\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Response

If the request is successful, you should receive a JSON response that looks similar to the following:

{
    "Success": true,
    "Message": "EmpowerID\\<Person Login Value> Password reset successfully",
    "Exception": null
}

In this article