Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14101465558.4 KB

Gets the user pool multi-factor authentication (MFA) configuration.

post/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserPoolMfaConfig

Headers

X-Amz-Target'AWSCognitoIdentityProviderService.GetUserPoolMfaConfig' required

Request body

UserPoolIdstring required

The user pool ID.

Response

Success

MfaConfiguration'OFF' | 'ON' | 'OPTIONAL'
<p>The multi-factor authentication (MFA) configuration. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li> </ul>