Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cognito-idp ]

set-user-mfa-preference

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  set-user-mfa-preference
[--sms-mfa-settings <value>]
[--software-token-mfa-settings <value>]
--access-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--sms-mfa-settings (structure)

The SMS text message multi-factor authentication (MFA) settings.

Enabled -> (boolean)

Specifies whether SMS text message 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)

Specifies whether SMS is the preferred MFA method.

Shorthand Syntax:

Enabled=boolean,PreferredMfa=boolean

JSON Syntax:

{
  "Enabled": true|false,
  "PreferredMfa": true|false
}

--software-token-mfa-settings (structure)

The time-based one-time password (TOTP) software token MFA settings.

Enabled -> (boolean)

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)

Specifies whether software token MFA is the preferred MFA method.

Shorthand Syntax:

Enabled=boolean,PreferredMfa=boolean

JSON Syntax:

{
  "Enabled": true|false,
  "PreferredMfa": true|false
}

--access-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To set user MFA settings

This example modifies the MFA delivery options. It changes the MFA delivery medium to SMS.

Command:

aws cognito-idp set-user-mfa-preference --access-token ACCESS_TOKEN --mfa-options DeliveryMedium="SMS",AttributeName="phone_number"

Output

None