Query Ticket Status for 2FA Login

Query the status of a pre-authentication ticket for 2FA login.

Request URL

GET {base_url}/uc-auth/api/v1/public/mfa/ticket-status

Request parameters

Query parameters
Parameter Required Type Description
ticket Yes String The pre-authentication ticket issued after the user's credentials are verified in the first step of the login process.
Note: You can obtain the ticket using the Get an Access Token interface.

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<Ticket_Status> The status of the pre-authentication ticket.
Ticket_Status
Parameter Type Description
valid Boolean

Whether the ticket is valid.

  • true: The ticket is valid.
  • false: The ticket is invalid.
remainingSeconds Integer The remaining validity period of the ticket.

Unit: Second
method String The 2FA verification method corresponding to the ticket.
maskedEmail String The email address associated with the ticket.

Example

Request example

GET /uc-auth/api/v1/public/mfa/ticket-status?ticket=QurrWNw4hdU6FWSyHxmatvFmKbWTb3MZ1Xlbkvg6fIU HTTP/1.1
Host: api.cn.novoone.com

Response example

HTTP/1.1 200 OK
{
  "result": {
    "valid": true,
    "remainingSeconds": 899,
    "method": "AUTHENTICATOR",
    "maskedEmail": "l*o@sample.com"
  },
  "requestId": "ba64b521513b2a5f6132ba98c4c043f0",
  "code": "200",
  "message": "SUCCESS"
}