Set user MFA status

Set user MFA status by user ID, you can choose to specify user ID type, etc.

Method name

ManagementClient.setUsersMfaStatus

Request parameters

Name	Type	Required	Default value	Description	Sample value
userId	string	Yes	-	User unique identifier, which can be user ID, user name, email address, 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	<a MfaTriggerData	Yes	-	User MFA trigger data

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a privately deployed customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.setUsersMfaStatus({
    // Replace user ID
    userId: "6229ffaxxxxxxxxcade3e3d9",
    userIdType: "user_id",
    mfaTriggerData: {
      mfaToken: "xxxxxxx",
      mfaPhone: null,
      mfaPhoneCountryCode: null,
      mfaEmail: null,
      nickname: null,
      username: null,
      phone: null,
      phoneCountryCode: null,
      faceMfaEnabled: true,
      totpMfaEnabled: true,
      applicationMfa: [
        {
          mfaPolicy: "EMAIL",
          status: 1,
          sort: 0,
        },
      ],
    },
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: IsSuccessRespDto

Name	Type	Description
statusCode	number	Business status code. This status code can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type.
requestId	string	Request ID. Returned when the request fails.
data	<a IsSuccessDto	Whether the operation is successful

Sample result:

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

Data structure

MfaTriggerData

Name	Type	Is it required	Description	Sample value
mfaToken	string	yes	MFA Token	xxxxxxx
applicationMfa	array	yes	MFA configuration type: <a ApplicationMfaDto.
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 mobile phone number	null
phoneCountryCode	string	No	User mobile area code	null
faceMfaEnabled	boolean	No	Face verification enabled	true
totpMfaEnabled	boolean	No	OTP verification enabled	true

ApplicationMfaDto

Name	Type	Is it required?	Description	Sample value
mfaPolicy	string	yes	MFA type	EMAIL
status	number	yes	Enabled status	1
sort	number	yes	Sort	0

IsSuccessDto

Name	Type	Is it required?	Description	Sample value
success	boolean	yes	whether the operation was successful	true