Get Forced 2FA Setting

Get the platform-level setting that indicates whether 2FA is enforced for all accounts.

Request URL

GET {base_url}/uc-auth/api/v1/admin/security/mfa/forced-config

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<Result> The forced 2FA setting.
Result
Parameter Type Description
enabled Boolean

Whether 2FA is enforced for all accounts.

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

Example

Request example

GET /uc-auth/api/v1/admin/security/mfa/forced-config 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

Response example

HTTP/1.1 200 OK
{
  "result": {
    "enabled": false
  },
  "requestId": "b69223f7c380433e7571f6b9691da8e8",
  "code": "200",
  "message": "SUCCESS"
}