/

POST

Set the user's multi-factor authentication (MFA) method preference, including which MFA factors 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. 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. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

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
    },
    "AccessToken": "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 multi-factor authentication (MFA) settings.

SoftwareTokenMfaSettings

object

optional

The time-based one-time password (TOTP) 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.

AccessToken

string <password>

required

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Match pattern:

[A-Za-z0-9-_=.]+

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482NotAuthorizedException

🟠483PasswordResetRequiredException

🟠484UserNotFoundException

🟠485UserNotConfirmedException

🟠486InternalErrorException

🟠487ForbiddenException

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