Password Unlock
POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/password
The POST /environments/{{envID}}/users/{{userID}}/password endpoint is called by an administrator or an application to unlock a user's password. This operation uses the application/vnd.pingidentity.password.unlock custom media type as the content type in the request header.
The sample shows the POST /environments/{{envID}}/users/{{userID}}/password operation to unlock a password 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 and generates a PASSWORD.UNLOCKED event.
Note: If the password lockout is the only reason for an account lockout, and the password unlock action causes the account to become unlocked, this event will also result in a USER.UNLOCKED event.
Prerequisites
See Users and User Passwords for important overview information.
Create a user to get a
userID. See Create User. Run Read User or Users to find an existing user.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"_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"}