- Development Integration
- /
- SDK
- /
- Java
- /
Management module
- /
Manage Applications
- /
- Get user MFA trigger data under the application
¶ Get the user MFA trigger data under the application
Update time: 2025-07-23 07:34:21
Get the user MFA trigger data under the application
¶ Method Name
ManagementClient.getMfaTriggerData
¶ Request Parameters
| Name | Type | Is it required | Default Value | Description | Example Value |
|---|---|---|---|---|---|
| appId | string | Yes | - | Application ID | 6229ffaxxxxxxxxcade3e3d9 |
| userId | string | Yes | - | User id | 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: username- 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 user's ID in the external identity source.Example Value: 62f20932716fbcc10d966ee5:ou_8bae746eac07cd2564654140d2a9ac61. | user_id |
¶ Sample Code
package test.management;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.GetMapInfoRespDto;
import cn.authing.sdk.java.dto.GetMfaTriggerDataDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;
public class GetMfaTriggerDataTest {
// 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);
GetMfaTriggerDataDto getMfaTriggerDataDto = new GetMfaTriggerDataDto();
getMfaTriggerDataDto.setUserId("64355exxxxxxxxx11d8ae12dc");
getMfaTriggerDataDto.setAppId("64355exxxxxxxxx11d8ae12dc");
GetMapInfoRespDto response = client.getMfaTriggerData(getMfaTriggerDataDto);
System.out.println(JsonUtils.serialize(response));
}
}
¶ Request Response
Type： GetMapInfoRespDto
| 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. |
Example Results：
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"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
}
]
}
}
¶ Data Structure
¶ MfaTriggerData
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| mfaToken | string | Yes | MFA Token | xxxxxxx |
| applicationMfa | array | Yes | MFA configuration Type: ApplicationMfaDto. | |
| mfaPhone | string | No | MFA bound phone number | null |
| mfaPhoneCountryCode | string | No | MFA bound phone area code | null |
| mfaEmail | string | No | MFA bound email | null |
| nickname | string | No | User nickname | null |
| username | string | No | User name | null |
| phone | string | No | User phone number | null |
| phoneCountryCode | string | No | User 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 |