Get global multi-factor authentication configuration
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.
Get global multi-factor authentication configuration without passing parameters
Method name
ManagementClient.get_global_mfa_settings
Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|
Request Response
Type: MFASettingsRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which 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 (not returned for successful requests). For a detailed list of error codes, see: API Code List |
| requestId | string | Request ID. Returned when the request fails. |
| data | <a MFASettingsDto | Response data |
Sample result:
json
{
"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"] |