PHphilterd
Users

Clear a user's sign-in lock.

Changed on

Clears the lock on a user's password sign-in after repeated failed sign-ins, before SIGN_IN_LOCKOUT_MINUTES ends, and resets the count of failures. The lock returns if sign-in keeps failing, so restrict who can reach sign-in when someone is locking a user out deliberately. Requires an administrator as well as the scope. Recorded as a sign_in_unlocked audit event naming the calling administrator and API key. Requires the users:write scope.

post/api/users/{username}/sign-in/unlock

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/{username}/sign-in/unlock
  • Auth
    HTTP bearer

Path parameters

usernamestring required

Headers

Authorizationstring required

Response

The user's sign-in was unlocked.

Changes