¶ Modify global multi-factor authentication configuration

Update time: 2025-07-23 07:34:21

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Pass in the MFA authentication factor list to enable,

¶ Method Name

ManagementClient.updateGlobalMfaSettings

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
enabledFactors	string[]	Yes	List of enabled MFA authentication factors	`["SMS"]`

¶ Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.EnrollFactorDto;
import cn.authing.sdk.java.dto.MFASettingsDto;
import cn.authing.sdk.java.dto.MFASettingsRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

import java.util.Collections;

public class UpdateGlobalMfaSettingsTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        MFASettingsDto reqDto = new MFASettingsDto();
        reqDto.setEnabledFactors(Collections.singletonList(EnrollFactorDto.FactorType.OTP.getValue()));
        MFASettingsRespDto response = client.updateGlobalMfaSettings(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

¶ Request Response

Type： MFASettingsRespDto

Name	Type	Description
statusCode	number	Business status code. You can use this status code to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segment error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see：API Code List (opens new window)
requestId	string	Request ID. Returned when the request fails.
data	MFASettingsDto	Response data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "enabledFactors": "[\"SMS\"]"
  }
}

¶ Data Structure

¶ MFASettingsDto

Name	Type	Is it required	Description	Example Value
enabledFactors	array	Yes	List of enabled MFA authentication factors	`["SMS"]`

Previous article: Get global multi-factor authentication configuration Next article: Get the list of email templates