/

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

X-Amz-Target

string

required

Body Params application/json

SMSMfaSettings

object

optional

The SMS text message MFA settings.

SoftwareTokenMfaSettings

object

optional

The time-based one-time password software token MFA settings.

Enabled

boolean

optional

Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

PreferredMfa

boolean

optional

Specifies whether software token MFA is the preferred MFA method.

Username

string <password>

required

The user pool username or alias.

>= 1 characters<= 128 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

UserPoolId

string

required

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482NotAuthorizedException

🟠483PasswordResetRequiredException

🟠484UserNotFoundException

🟠485UserNotConfirmedException

🟠486InternalErrorException

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