Clear a user's sign-in lockout
POST /admin/users/{ref}/unlock-account
Clears a user’s failed sign-in count and any lockout time, so a lockout no longer stops them signing in.
Anything to clear counts: a count above zero or a lockout time that
is set, even one that has already passed. Then unlocked is true
and prior_failed_count has the old count. If there’s nothing to
clear you get unlocked: false.
It doesn’t touch the separate limit on sign-in attempts from one
address, the password, two-factor settings, sessions or tokens. A
change is recorded in the audit log as auth.lockout.cleared on a
best-effort basis; nothing is recorded when there was nothing to
clear. You need auth.unlock (system.admin also works).
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”What the call did; unlocked says whether anything was cleared.
What the unlock did.
object
true when a failed sign-in count or lockout time was cleared,
false when there was nothing to clear. true doesn’t mean the
account was locked at that moment.
The failed sign-in count before it was cleared. 0 when unlocked is
false.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Authenticated but missing required capabilities
object
Human-readable error summary
Example
the request could not be completedResource not found
object
Human-readable error summary
Example
the request could not be completed