CognitoIdentityProvider / Client / set_user_pool_mfa_config

set_user_pool_mfa_config#

CognitoIdentityProvider.Client.set_user_pool_mfa_config(**kwargs)#

Sets the user pool multi-factor authentication (MFA) and passkey configuration.

Note

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Request Syntax

response = 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'
    }
)

Parameters:

UserPoolId (string) –
[REQUIRED]

The user pool ID.
SmsMfaConfiguration (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.
SoftwareTokenMfaConfiguration (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.
EmailMfaConfiguration (dict) –
Configures user pool email messages for MFA. Sets the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.
- Message (string) –
  
  The template for the email message that your user pool sends to users with an MFA code. 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 message that your user pool sends to users with an MFA code.
MfaConfiguration (string) –
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
- OFF MFA won’t be used for any users.
- ON MFA is required for all users to sign in.
- OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
WebAuthnConfiguration (dict) –
The configuration of your user pool for passkey, or webauthN, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.
- 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) –
  
  Sets or displays your user-pool treatment for MFA with a passkey. You can override other MFA options and require passkey MFA, or you can set it as preferred. When passkey MFA is preferred, the hosted UI encourages users to register a passkey at sign-in.

Return type:

dict

Returns:

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'
    }
}

Response Structure

(dict) –
- SmsMfaConfiguration (dict) –
  
  Shows user pool SMS message configuration for 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 user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.
  - Message (string) –
    
    The template for the email message that your user pool sends to users with an MFA code. 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 message that your user pool sends to users with an MFA code.
- MfaConfiguration (string) –
  
  The MFA configuration. Valid values include:
  - OFF MFA won’t be used for any users.
  - ON MFA is required for all users to sign in.
  - OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
- WebAuthnConfiguration (dict) –
  
  The configuration of your user pool for passkey, or webauthN, biometric and security-key devices.
  - 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) –
    
    Sets or displays your user-pool treatment for MFA with a passkey. You can override other MFA options and require passkey MFA, or you can set it as preferred. When passkey MFA is preferred, the hosted UI encourages users to register a passkey at sign-in.