Unlock 2FA for a User

Unlock an account that has been locked due to consecutive 2FA verification failures.

Request URL

POST {base_url}/uc-auth/api/v1/admin/security/mfa/unlock

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.

Example

Request example

POST /uc-auth/api/v1/admin/security/mfa/unlock?username=1000@jint HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTg4NDg2NywiaWF0IjoxNzkxODYzMjY3LCJqdGkiOiIyMzk1Zjk2NS01MjA3LTRhN2QtYjc0ZS1mNmJjZmQxN2JiZGYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.dedsPD_95Rya6EPkzg-ygaC-BHfwlTF4y3CrK1v6Sm8Ga8bgGuNWc8hjkW2YBIF3poXdL9Ptu4LDzypjv4Zc2gUJru22UEnkVjpC_RyPtUzRUz2g1YixqQlXwAklmzYB9zxD9e3HW3RKNzd9nswqNjDKGabbSMzCrJauecoxZPoBXy-ttStuMBQKOHwDOf0rE6sWjGXBkdb70BzvwA1HUAx_sA--l5WYKhRGbnYSv93LBeLLufI_lXEaPcX8fg17nocZTednmGGkFJifOEiG2QGHYySbJ84NzoOo46jOxsPdpLHYXTYjnUuuQH5m5k3niLXYhnsWV-S9UzgDWqLSVg

Response example

HTTP/1.1 200 OK
{
  "requestId": "96fad3b891273dda85b2b8bbb7508204",
  "code": "200",
  "message": "SUCCESS"
}