Skip to content

Request account unlock instructions

POST
/users/unlock

Sends unlock instructions email to the given address. In paranoid mode (default), always returns success — even if the email is not registered or the account is not locked — to prevent email enumeration. Blank email returns 422. Requires lockout to be enabled with an email-based unlock strategy (both or email).

Request Body

application/json
JSON
{
  
"user": {
  
  
"email": "jane@example.com"
  
}
}

Responses

Instructions sent (or paranoid success)

application/json
JSON
{
  
"toast": {
  
  
"title": "Instructions sent.",
  
  
"message": [
  
  
  
"If your email address exists in our database, you will receive an email with instructions for how to unlock your account in a few minutes."
  
  
],
  
  
"variant": "success"
  
}
}

Playground

Server
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)