Reset Passwords
To utilize the API for performing operations or retrieving data required by your application, initiate a POST request to the relevant endpoint. The following example illustrates how to make an API call to reset a person's password:
Endpoint
https://<YourEmpowerIDServer>/api/services/v1/PasswordPolicy/ResetPassword
Headers
Key | Value |
---|---|
X-EmpowerID-API-Key | The API key for the OAuth application you registered in EmpowerID. |
Authorization | The OAuth token of the person making the API call. |
Content-Type | application/json |
Request Data
Request data is sent to the API in JSON format. The sample data in the below request represents the key/value pairs required for resetting a person’s password.
{"PersonID":"123456", Password":"Newp@$$w0rd","UnlockAccounts":false,"MustChangePasswordOnNextLogin":false}
Â
Request Parameter | Type | Required / Optional | Description |
---|---|---|---|
PersonID | Integer | Required | Person ID of the target person |
Password | String | Required | New password |
UnlockAccounts | Boolean | Required | Specified whether to unlock the person’s accounts |
MustChangePasswordOnNextLogin | Boolean | Required | Specifies whether the person must change their password the next time they log in to the system |
Â
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/PasswordPolicy/ResetPassword' \
--header 'Content-Type: application/json' \
--data-raw '{
"Password": "<string>",
"PersonID": "<integer>",
"UnlockAccounts": "<boolean>",
"MustChangePasswordOnNextLogin": "<boolean>"
}'
C#
Response
If the request is successful, you should receive a JSON response that looks similar to the following:
Â
Â
Â