Query 2FA Setting

Query 2FA settings of the current user and whether 2FA is enforced for all users.

Request URL

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

Request parameters

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

Format: Bearer {access_token}.

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<2FA_Status> The 2FA status.
2FA_Status
Parameter Type Description
enabled Boolean

Whether 2FA is enabled for the current user.

  • true: 2FA is enabled.
  • false: 2FA is not enabled.
method String

The 2FA verification method configured for the current user.

  • AUTHENTICATOR: Authenticator app.
  • EMAIL: Email.
forcedEnabled Boolean

Whether 2FA is enforced for all users.

  • true: 2FA is enforced for all users.
  • false: 2FA is not enforced for all users.

Example

Request example

GET /uc-auth/api/v1/mfa/status HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MTg4NDc1NSwiaWF0IjoxNzkxODYzMTU1LCJqdGkiOiJiZTI3MWJlMC05NzdhLTQxYmItOTM4My0zMTcwMDQxYmQyOGIiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6IjM4N2MzMGFiLTMyZTQtNDA5OS1hYWQ2LTZhMTc0MDZjOWQ2NyIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.OECMIAzAvXeOjt5hAQNJJqOvQMIAlISSYQI50oy-nsYMSz-gCcnIza1sfs6h84-SiGm84NSSbn5qWAfIsi-pATDstMsqsltgmqaxuwszc1hlBZqEVv1Wfoa11ez2TS_gjUFR7vpMv1qSbeBVoVSMqgF6D86jbLOBLrhvVOR-PvTp1QnPrj8l0f2jPFlOIr8ecaRazcDuODB6Hnf7QYSjMaKD60vIVuIEKCYnmpYeInMAroFETCDzS53IJu-FBQucETpb-4LLzzuSnx8Iw_3esDPLfCpqeJVpxst1cleijSIkksEILmSHNivnpHDmXI8vjEkHCqYBs0ie4XY7cHIAqw

Response example

HTTP/1.1 200 OK
{
  "result": {
    "enabled": true,
    "method": "AUTHENTICATOR",
    "forcedEnabled": false
  },
  "requestId": "182eca7198359e980b2f0e381e93fea6",
  "code": "200",
  "message": "SUCCESS"
}