From Bright Pattern Documentation
• 5.2
Clear User Lock State
Resets a temporary lockout if a user's account has been temporarily locked out after too many invalid login attempts.
Request
URL
http[s]://<host>/configapi/v2/user/lock/<login_id>
For example:
http://example.com/configapi/v2/user/mo.williams
HTTP Method
PUT
Content-Type
application/json
Parameters
Parameter | Data-Type | Description | Example |
login_id | string | The username of the user | "mo.williams" |
Request Body
Empty. All you need is the username in the URL.
Response
In response to a successful request, the "lockedOut" state is set to "false."
You can verify the user's lockstate in Contact Center Administrator > Users & Teams > Users.
Parameters
Parameter | Data-Type | Description | Example |
lockedOut | Boolean | Whether the user is locked out ("true") or not ("false") | true |
Example Response
{
"lockedOut":false
}