2026/04/16 - Amazon Cognito Identity Provider - 4 updated api methods
Changes Adds support for passkey-based multi-factor authentication in Cognito User Pools. Users can authenticate securely using FIDO2-compliant passkeys with user verification, enabling passwordless MFA flows while maintaining backward compatibility with password-based authentication
{'WebAuthnMfaSettings': {'Enabled': 'boolean'}}
Sets 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
Request Syntax
client.admin_set_user_mfa_preference(
SMSMfaSettings={
'Enabled': True|False,
'PreferredMfa': True|False
},
SoftwareTokenMfaSettings={
'Enabled': True|False,
'PreferredMfa': True|False
},
EmailMfaSettings={
'Enabled': True|False,
'PreferredMfa': True|False
},
WebAuthnMfaSettings={
'Enabled': True|False
},
Username='string',
UserPoolId='string'
)
dict
User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.
Enabled (boolean) --
Specifies whether SMS 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. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.
dict
User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available.
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.
dict
User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.
Enabled (boolean) --
Specifies whether email message MFA is active for a user. When the value of this parameter is Enabled, 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 email message MFA is the user's preferred method.
dict
User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the FactorConfiguration of your user pool WebAuthnConfiguration must be MULTI_FACTOR_WITH_USER_VERIFICATION. To activate this setting, your user pool must be in the Essentials tier or higher.
Enabled (boolean) --
Specifies whether passkey MFA is activated for a user. When activated, the user's passkey authentication requires user verification, and passkey sign-in is available when MFA is required. The user must also have at least one other MFA method such as SMS, TOTP, or email activated to prevent account lockout.
string
[REQUIRED]
The name 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.
string
[REQUIRED]
The ID of the user pool where you want to set a user's MFA preferences.
dict
Response Syntax
{}
Response Structure
(dict) --
{'WebAuthnConfiguration': {'FactorConfiguration': 'SINGLE_FACTOR | '
'MULTI_FACTOR_WITH_USER_VERIFICATION'}}
Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA). This operation describes the following:
The WebAuthn relying party (RP) ID and user-verification settings.
The required, optional, or disabled state of MFA for all user pool users.
The message templates for email and SMS MFA.
The enabled or disabled state of time-based one-time password (TOTP) MFA.
See also: AWS API Documentation
Request Syntax
client.get_user_pool_mfa_config(
UserPoolId='string'
)
string
[REQUIRED]
The ID of the user pool where you want to query WebAuthn and MFA configuration.
dict
Response Syntax
{
'SmsMfaConfiguration': {
'SmsAuthenticationMessage': 'string',
'SmsConfiguration': {
'SnsCallerArn': 'string',
'ExternalId': 'string',
'SnsRegion': 'string'
}
},
'SoftwareTokenMfaConfiguration': {
'Enabled': True|False
},
'EmailMfaConfiguration': {
'Message': 'string',
'Subject': 'string'
},
'MfaConfiguration': 'OFF'|'ON'|'OPTIONAL',
'WebAuthnConfiguration': {
'RelyingPartyId': 'string',
'UserVerification': 'required'|'preferred',
'FactorConfiguration': 'SINGLE_FACTOR'|'MULTI_FACTOR_WITH_USER_VERIFICATION'
}
}
Response Structure
(dict) --
SmsMfaConfiguration (dict) --
Shows user pool configuration for SMS message MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.
SmsAuthenticationMessage (string) --
The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.
SmsConfiguration (dict) --
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.
SnsCallerArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
ExternalId (string) --
The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party.
SnsRegion (string) --
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
SoftwareTokenMfaConfiguration (dict) --
Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.
Enabled (boolean) --
The activation state of TOTP MFA.
EmailMfaConfiguration (dict) --
Shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
Message (string) --
The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.
Subject (string) --
The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.
MfaConfiguration (string) --
Displays the state of multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
WebAuthnConfiguration (dict) --
Shows user pool configuration for sign-in with passkey authenticators such as biometric devices and security keys. Includes relying-party configuration, user-verification requirements, and whether passkeys can satisfy MFA requirements.
RelyingPartyId (string) --
Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.
Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:
The user pool is configured for passkey authentication.
The user pool has a custom domain, whether or not it also has a prefix domain.
Your application performs authentication with managed login or the classic hosted UI.
UserVerification (string) --
When required, users can only register and sign in users with passkeys that are capable of user verification. When preferred, your user pool doesn't require the use of authenticators with user verification but encourages it.
FactorConfiguration (string) --
Sets whether passkeys can be used as multi-factor authentication (MFA). When set to MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user verification satisfies MFA requirements. When set to SINGLE_FACTOR or not set, passkeys are a single authentication factor. To activate this setting, your user pool must be in the Essentials tier or higher.
{'WebAuthnMfaSettings': {'Enabled': 'boolean'}}
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.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
See also: AWS API Documentation
Request Syntax
client.set_user_mfa_preference(
SMSMfaSettings={
'Enabled': True|False,
'PreferredMfa': True|False
},
SoftwareTokenMfaSettings={
'Enabled': True|False,
'PreferredMfa': True|False
},
EmailMfaSettings={
'Enabled': True|False,
'PreferredMfa': True|False
},
WebAuthnMfaSettings={
'Enabled': True|False
},
AccessToken='string'
)
dict
User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.
Enabled (boolean) --
Specifies whether SMS 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. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.
dict
User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. Users must register a TOTP authenticator before they set this as their preferred MFA method.
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.
dict
User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.
Enabled (boolean) --
Specifies whether email message MFA is active for a user. When the value of this parameter is Enabled, 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 email message MFA is the user's preferred method.
dict
User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the FactorConfiguration of your user pool WebAuthnConfiguration must be MULTI_FACTOR_WITH_USER_VERIFICATION. To activate this setting, your user pool must be in the Essentials tier or higher.
Enabled (boolean) --
Specifies whether passkey MFA is activated for a user. When activated, the user's passkey authentication requires user verification, and passkey sign-in is available when MFA is required. The user must also have at least one other MFA method such as SMS, TOTP, or email activated to prevent account lockout.
string
[REQUIRED]
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.
dict
Response Syntax
{}
Response Structure
(dict) --
{'WebAuthnConfiguration': {'FactorConfiguration': 'SINGLE_FACTOR | '
'MULTI_FACTOR_WITH_USER_VERIFICATION'}}
Sets user pool multi-factor authentication (MFA) and passkey configuration. For more information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows.
See also: AWS API Documentation
Request Syntax
client.set_user_pool_mfa_config(
UserPoolId='string',
SmsMfaConfiguration={
'SmsAuthenticationMessage': 'string',
'SmsConfiguration': {
'SnsCallerArn': 'string',
'ExternalId': 'string',
'SnsRegion': 'string'
}
},
SoftwareTokenMfaConfiguration={
'Enabled': True|False
},
EmailMfaConfiguration={
'Message': 'string',
'Subject': 'string'
},
MfaConfiguration='OFF'|'ON'|'OPTIONAL',
WebAuthnConfiguration={
'RelyingPartyId': 'string',
'UserVerification': 'required'|'preferred',
'FactorConfiguration': 'SINGLE_FACTOR'|'MULTI_FACTOR_WITH_USER_VERIFICATION'
}
)
string
[REQUIRED]
The user pool ID.
dict
Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.
SmsAuthenticationMessage (string) --
The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.
SmsConfiguration (dict) --
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.
SnsCallerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
ExternalId (string) --
The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party.
SnsRegion (string) --
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
dict
Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.
Enabled (boolean) --
The activation state of TOTP MFA.
dict
Sets configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
Message (string) --
The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.
Subject (string) --
The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.
string
Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
dict
The configuration of your user pool for passkey, or WebAuthn, authentication and registration. Includes relying-party configuration, user-verification requirements, and whether passkeys can satisfy MFA requirements.
RelyingPartyId (string) --
Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.
Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:
The user pool is configured for passkey authentication.
The user pool has a custom domain, whether or not it also has a prefix domain.
Your application performs authentication with managed login or the classic hosted UI.
UserVerification (string) --
When required, users can only register and sign in users with passkeys that are capable of user verification. When preferred, your user pool doesn't require the use of authenticators with user verification but encourages it.
FactorConfiguration (string) --
Sets whether passkeys can be used as multi-factor authentication (MFA). When set to MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user verification satisfies MFA requirements. When set to SINGLE_FACTOR or not set, passkeys are a single authentication factor. To activate this setting, your user pool must be in the Essentials tier or higher.
dict
Response Syntax
{
'SmsMfaConfiguration': {
'SmsAuthenticationMessage': 'string',
'SmsConfiguration': {
'SnsCallerArn': 'string',
'ExternalId': 'string',
'SnsRegion': 'string'
}
},
'SoftwareTokenMfaConfiguration': {
'Enabled': True|False
},
'EmailMfaConfiguration': {
'Message': 'string',
'Subject': 'string'
},
'MfaConfiguration': 'OFF'|'ON'|'OPTIONAL',
'WebAuthnConfiguration': {
'RelyingPartyId': 'string',
'UserVerification': 'required'|'preferred',
'FactorConfiguration': 'SINGLE_FACTOR'|'MULTI_FACTOR_WITH_USER_VERIFICATION'
}
}
Response Structure
(dict) --
SmsMfaConfiguration (dict) --
Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs. Includes the message template and the SMS message sending configuration for Amazon SNS.
SmsAuthenticationMessage (string) --
The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.
SmsConfiguration (dict) --
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.
SnsCallerArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a spending limit.
ExternalId (string) --
The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party.
SnsRegion (string) --
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
SoftwareTokenMfaConfiguration (dict) --
Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.
Enabled (boolean) --
The activation state of TOTP MFA.
EmailMfaConfiguration (dict) --
Shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
Message (string) --
The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.
Subject (string) --
The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.
MfaConfiguration (string) --
Displays multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
WebAuthnConfiguration (dict) --
The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators such as biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.
RelyingPartyId (string) --
Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.
Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:
The user pool is configured for passkey authentication.
The user pool has a custom domain, whether or not it also has a prefix domain.
Your application performs authentication with managed login or the classic hosted UI.
UserVerification (string) --
When required, users can only register and sign in users with passkeys that are capable of user verification. When preferred, your user pool doesn't require the use of authenticators with user verification but encourages it.
FactorConfiguration (string) --
Sets whether passkeys can be used as multi-factor authentication (MFA). When set to MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user verification satisfies MFA requirements. When set to SINGLE_FACTOR or not set, passkeys are a single authentication factor. To activate this setting, your user pool must be in the Essentials tier or higher.