Get a User Lock Status

Gets the lock status of a user.

Request URL

GET {base_url}/uc-user/api/v1/admin/security/lock-status

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
Query parameters
Parameter Required Type Description
username Yes String The username of the user to query.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Lock_Status> The lock status of the user.
Lock_Status
Parameter Type Description
username String The username of the user.
locked Boolean Whether the user is locked.
remainingSeconds Integer The remaining seconds of the lock.
failureCount Integer The number of consecutive login failures.
requiresCaptcha Boolean Whether a captcha is required for the next login attempt.

Example

Request example

GET /uc-user/api/v1/admin/security/lock-status?username=mt1000@mailstar.top HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwiYXBwX2tleSI6Im9icWJUSWd1ZkJ5d3ZCNmF0VURmVDZpeDJvUlhUb0wzIiwiZ3JhbnRfdHlwZSI6Im9wZW5hcGkiLCJjbGllbnRfZXh0Ijp7ImRlc2NyaXB0aW9uIjoi56ys5LiJ5pa55ZCI5L2c5LyZ5Ly05bqU55SoIiwicGFydG5lciI6IuekuuS-i-WQiOS9nOS8meS8tCJ9LCJjbGllbnRfdHlwZSI6Im9wZW5hcGkiLCJleHAiOjE3OTIwNzU4MzksImlhdCI6MTc5MjA1NDIzOSwianRpIjoiNmIxNTdhMTItOTc3Mi00ZTQ3LWIzNDEtZGMzMzhlMzcwYWFkIiwiY2xpZW50X2lkIjoibm92by1vcGVuLXBsYXRmb3JtIiwidXNlcl9leHQiOnsicm9sZUlkcyI6WzNdLCJzdHlwZSI6IkFETUlOIiwidGVuYW50Q29kZSI6bnVsbCwidHlwZSI6IlBfQUNDT1VOVCIsInVzZXJJZCI6MjA4NTMxNTk0ODg0OTgyNzg0MiwiZW1haWwiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidXNlcm5hbWUiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidWNJZCI6MjA4NTMxNTk0ODI4Nzc5MTEwNn19.bayAAcd25Y7rW9a0eWF0uHP6IBJHaiG5PfnclIIB-JOHY-WVQM_zGlBe8EinHuvzpvDnF9VtPtW_5VN_RvYCmRFjxRtHU8ygl-ktznZpqtMZSAmXeBnJJkhCzPeM6eS7mF29dk5l016E2PUiDgXqsG5ZS-e_r1SCaNHdqLik60AQDoyiKVT7hDTSaXaVqD2NmDdjm3S2-hClC8VB0NdnPot0qd-Kv6CrVDnZ5TuMdAQ0cm_qG81PLxB4To4kwqyi_G2LBcYiqoFfZXK6BMJo2_N4xP7bEvcZ5HT1Qy2s1yW42jk5kkvjfhUFfrvZcswoFuuLuw870ngG_ahD95xV7A

Response example

HTTP/1.1 200 OK
{
  "result": {
    "username": "mt1000@mailstar.top",
    "locked": false,
    "remainingSeconds": 0,
    "failureCount": 0,
    "requiresCaptcha": false
  },
  "requestId": "3809222cff2319e680e8bc3e90b99d67",
  "code": "200",
  "message": "SUCCESS"
}