¶ Set user MFA status

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

Use user ID to set user MFA status. You can choose to specify user ID type, etc.

¶ Method Name

ManagementClient.setUsersMfaStatus

¶ Request Parameters

Name	Type	Is it required	Default Value	Description	Example Value
userId	string	Yes	-	User unique identifier, which can be user ID, user name, email address, mobile phone number, external ID, or ID in an external identity source.	`6229ffaxxxxxxxxcade3e3d9`
userIdType	string	No	user_id	User id type, the default value is `user_id`, the optional values are: - `user_id`: GenAuth user ID, such as `6319a1504f3xxxxf214dd5b7` - `phone`: user phone number - `email`: user email - `username`: user name - `external_id`: user ID in the external system, corresponding to the `externalId` field of GenAuth user information - `identity`: user's external identity source information, the format is `<extIdpId>:<userIdInIdp>`, where `<extIdpId>` is the ID of the GenAuth identity source, and `<userIdInIdp>` is the ID of the user in the external identity source. Example Value: `62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61`.	`user_id`
mfaTriggerData	MfaTriggerData	Yes	-	User MFA trigger data

¶ Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.ApplicationMfaDto;
import cn.authing.sdk.java.dto.GetMfaInfoDataDto;
import cn.authing.sdk.java.dto.IsSuccessRespDto;
import cn.authing.sdk.java.dto.SetMfaStatusDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;
import java.util.ArrayList;
import java.util.List;

public class SetUserMfaStatusTest {
    // 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);

        SetMfaStatusDto setMfaStatusDto = new SetMfaStatusDto();
        setMfaStatusDto.setUserId("64355exxxxxxxxx11d8ae12dc");
        GetMfaInfoDataDto getMfaInfoDataDto = new GetMfaInfoDataDto();
        getMfaInfoDataDto.setMfaToken("xxxxx");
        getMfaInfoDataDto.setMfaPhone("130xxxx4456");
        List<ApplicationMfaDto> applicationMfa = new ArrayList<>();
        ApplicationMfaDto applicationMfaDto = new ApplicationMfaDto();
        applicationMfaDto.setMfaPolicy("SMS");
        applicationMfaDto.setStatus(1);
        applicationMfaDto.setSort(1);
        applicationMfa.add(applicationMfaDto);
        getMfaInfoDataDto.setApplicationMfa(applicationMfa);
        setMfaStatusDto.setMfaTriggerData(getMfaInfoDataDto);
        IsSuccessRespDto response = client.setUsersMfaStatus(setMfaStatusDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

¶ Request Response

Type： IsSuccessRespDto

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	This error code is used to get the specific error type.
requestId	string	Request ID. Returned when the request fails.
data	IsSuccessDto	Whether the operation is successful

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "success": true
  }
}

¶ Data Structure

¶ MfaTriggerData

Name	Type	Is it required	Description	Example Value
mfaToken	string	Yes	MFA Token	`xxxxxxx`
mfaPhone	string	No	Mobile phone number bound to MFA	`null`
mfaPhoneCountryCode	string	No	Mobile area code bound to MFA	`null`
mfaEmail	string	No	Email address bound to MFA	`null`
nickname	string	No	User nickname	`null`
username	string	No	User name	`null`
phone	string	No	User phone number	`null`
phoneCountryCode	string	No	User's mobile phone area code	`null`
faceMfaEnabled	boolean	No	Face verification Yes No Enable	`true`
totpMfaEnabled	boolean	No	OTP verification Yes No Enable	`true`

¶ ApplicationMfaDto

Name	Type	Is it required	Description	Example Value
mfaPolicy	string	Yes	MFA type	`EMAIL`
status	number	Yes	Yes No Enabled status	1
sort	number	Yes	Sorting	0

¶ IsSuccessDto

Name	Type	Is it required	Description	Example Value
success	boolean	Yes	Whether the operation is successful	`true`

Previous article: Import user OTP Next article: Get user MFA status