[ aws . cognito-idp ]

admin-set-user-mfa-preference

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  admin-set-user-mfa-preference
[--sms-mfa-settings <value>]
[--software-token-mfa-settings <value>]
--username <value>
--user-pool-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--sms-mfa-settings (structure)

The SMS text message 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 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
}

--username (string)

The user pool username or alias.

--user-pool-id (string)

The user pool ID.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

To set the user MFA preference

This example sets the SMS MFA preference for username diego@example.com.

Command:

aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false

Output

None