cognitoidentityprovider_admin_set_user_mfa_preference: The user's multi-factor authentication (MFA) preference,...

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred

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 https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_set_user_mfa_preference/ for full documentation.

Usage

cognitoidentityprovider_admin_set_user_mfa_preference(
  SMSMfaSettings = NULL,
  SoftwareTokenMfaSettings = NULL,
  Username,
  UserPoolId
)

Arguments

SMSMfaSettings	The SMS text message MFA settings.
SoftwareTokenMfaSettings	The time-based one-time password software token MFA settings.
Username	[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
UserPoolId	[required] The user pool ID.

paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.