| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CognitoIdentityProvider.SetUserMFAPreference
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.
Synopsis
- data SetUserMFAPreference = SetUserMFAPreference' {}
- newSetUserMFAPreference :: Text -> SetUserMFAPreference
- setUserMFAPreference_sMSMfaSettings :: Lens' SetUserMFAPreference (Maybe SMSMfaSettingsType)
- setUserMFAPreference_softwareTokenMfaSettings :: Lens' SetUserMFAPreference (Maybe SoftwareTokenMfaSettingsType)
- setUserMFAPreference_accessToken :: Lens' SetUserMFAPreference Text
- data SetUserMFAPreferenceResponse = SetUserMFAPreferenceResponse' {
- httpStatus :: Int
- newSetUserMFAPreferenceResponse :: Int -> SetUserMFAPreferenceResponse
- setUserMFAPreferenceResponse_httpStatus :: Lens' SetUserMFAPreferenceResponse Int
Creating a Request
data SetUserMFAPreference Source #
See: newSetUserMFAPreference smart constructor.
Constructors
| SetUserMFAPreference' | |
Fields
| |
Instances
newSetUserMFAPreference Source #
Arguments
| :: Text | |
| -> SetUserMFAPreference |
Create a value of SetUserMFAPreference with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sMSMfaSettings:SetUserMFAPreference', setUserMFAPreference_sMSMfaSettings - The SMS text message multi-factor authentication (MFA) settings.
$sel:softwareTokenMfaSettings:SetUserMFAPreference', setUserMFAPreference_softwareTokenMfaSettings - The time-based one-time password (TOTP) software token MFA settings.
SetUserMFAPreference, setUserMFAPreference_accessToken - A valid access token that Amazon Cognito issued to the user whose MFA
preference you want to set.
Request Lenses
setUserMFAPreference_sMSMfaSettings :: Lens' SetUserMFAPreference (Maybe SMSMfaSettingsType) Source #
The SMS text message multi-factor authentication (MFA) settings.
setUserMFAPreference_softwareTokenMfaSettings :: Lens' SetUserMFAPreference (Maybe SoftwareTokenMfaSettingsType) Source #
The time-based one-time password (TOTP) software token MFA settings.
setUserMFAPreference_accessToken :: Lens' SetUserMFAPreference Text Source #
A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
Destructuring the Response
data SetUserMFAPreferenceResponse Source #
See: newSetUserMFAPreferenceResponse smart constructor.
Constructors
| SetUserMFAPreferenceResponse' | |
Fields
| |
Instances
newSetUserMFAPreferenceResponse Source #
Create a value of SetUserMFAPreferenceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SetUserMFAPreferenceResponse', setUserMFAPreferenceResponse_httpStatus - The response's http status code.
Response Lenses
setUserMFAPreferenceResponse_httpStatus :: Lens' SetUserMFAPreferenceResponse Int Source #
The response's http status code.