Query 2FA Lock Status

Query the 2FA lock status of a specified user.

Request URL

GET {base_url}/uc-auth/api/v1/admin/security/mfa/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 login username.
Format:
  • For platform accounts, the username is the login email address.

    Example: admin@sample.com

  • For tenant users, the username is in the format {extension_number}@{tenant_code}.

    Example: 1001@jint

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 2FA lock status.
Lock_Status
Parameter Type Description
username String The login username.
locked Boolean

Whether the account is locked due to consecutive 2FA verification failures.

  • true: The account is locked.
  • false: The account is not locked.
remainingSeconds Integer The remaining time of the lock.

Unit: Second

Note: A value of 0 indicates the account is not locked.
failCount Integer The number of consecutive 2FA verification failures within 30 minutes.
Note: The account is locked when the count reaches 10.

Example

Request example

GET /uc-auth/api/v1/admin/security/mfa/lock-status?username=1000@jint HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTg4NDU5MiwiaWF0IjoxNzkxODYyOTkyLCJqdGkiOiI5ZjNiNWNhMy03MTY5LTRmYzUtODFjYi1mMjllZTMzNWFlYjQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.pjPynw6scP4MQGMMELoofwhcH6_SX0OMQYHcsMikWg_CXWJ8SA6GrOGzZFju1XurYurjQUDjniLSsTRfiKm-dvNo3JZImDqY7h2p7jEl7anwF_M-_kqdK0u6588jkwe0kT3h7Mz45H3VdJqUKEoN2A2u5sGRLu4DhO3a0yr5l0OVykHF8u9PqL3eT3e8tkFxGtMk8xstc8qi5Y4fgRn-1lA47UwZQp-bfrLMnxY6QMO-vElY6kOnVcjMsI32NVDg-6DpF1RWbroUD8vrubMyzUgVcIhKI7c_ZSbYIrY2r-D2sG6lxBCP4QBKfxScmYkg5WjXqL6OzaLLL6PWnSN_nw
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "result": {
    "username": "1000@jint",
    "locked": false,
    "remainingSeconds": 0,
    "failCount": 0
  },
  "requestId": "30a6b9c441cff036a04892c54db8bb90",
  "code": "200",
  "message": "SUCCESS"
}