/

POST

The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "SMSMfaSettings": {},
    "SoftwareTokenMfaSettings": {
        "Enabled": true,
        "PreferredMfa": true
    },
    "Username": "string",
    "UserPoolId": "string"
}'

Response Example

200 - Example 1

{}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482NotAuthorizedException

🟠483PasswordResetRequiredException

🟠484UserNotFoundException

🟠485UserNotConfirmedException

🟠486InternalErrorException

Modified at 2023-08-15 07:11:06