SetUserPoolMfaConfig
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.
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
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
{
"EmailMfaConfiguration": {
"Message": "string
",
"Subject": "string
"
},
"MfaConfiguration": "string
",
"SmsMfaConfiguration": {
"SmsAuthenticationMessage": "string
",
"SmsConfiguration": {
"ExternalId": "string
",
"SnsCallerArn": "string
",
"SnsRegion": "string
"
}
},
"SoftwareTokenMfaConfiguration": {
"Enabled": boolean
},
"UserPoolId": "string
",
"WebAuthnConfiguration": {
"RelyingPartyId": "string
",
"UserVerification": "string
"
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- EmailMfaConfiguration
-
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.
Type: EmailMfaConfigType object
Required: No
- MfaConfiguration
-
Sets multi-factor authentication (MFA) to be on, off, or optional. When
ON
, all users must set up MFA before they can sign in. WhenOPTIONAL
, 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, chooseOPTIONAL
.When
MfaConfiguration
isOPTIONAL
, 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.Type: String
Valid Values:
OFF | ON | OPTIONAL
Required: No
- SmsMfaConfiguration
-
Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.
Type: SmsMfaConfigType object
Required: No
- SoftwareTokenMfaConfiguration
-
Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.
Type: SoftwareTokenMfaConfigType object
Required: No
- UserPoolId
-
The user pool ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
- WebAuthnConfiguration
-
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.
Type: WebAuthnConfigurationType object
Required: No
Response Syntax
{
"EmailMfaConfiguration": {
"Message": "string",
"Subject": "string"
},
"MfaConfiguration": "string",
"SmsMfaConfiguration": {
"SmsAuthenticationMessage": "string",
"SmsConfiguration": {
"ExternalId": "string",
"SnsCallerArn": "string",
"SnsRegion": "string"
}
},
"SoftwareTokenMfaConfiguration": {
"Enabled": boolean
},
"WebAuthnConfiguration": {
"RelyingPartyId": "string",
"UserVerification": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EmailMfaConfiguration
-
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.
Type: EmailMfaConfigType object
- MfaConfiguration
-
Displays multi-factor authentication (MFA) as on, off, or optional. When
ON
, all users must set up MFA before they can sign in. WhenOPTIONAL
, 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, chooseOPTIONAL
.When
MfaConfiguration
isOPTIONAL
, 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.Type: String
Valid Values:
OFF | ON | OPTIONAL
- SmsMfaConfiguration
-
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.
Type: SmsMfaConfigType object
- SoftwareTokenMfaConfiguration
-
Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.
Type: SoftwareTokenMfaConfigType object
- WebAuthnConfiguration
-
The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators like biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.
Type: WebAuthnConfigurationType object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
This exception is thrown if two or more modifications are happening concurrently.
HTTP Status Code: 400
- FeatureUnavailableInTierException
-
This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.
HTTP Status Code: 400
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- InvalidSmsRoleAccessPolicyException
-
This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
HTTP Status Code: 400
- InvalidSmsRoleTrustRelationshipException
-
This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust
cognito-idp.amazonaws.com
or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
Examples
Example
The following example request configures optional MFA in the user pool, message configuration and templates, and WebAuthn.
Sample Request
POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.SetUserPoolMfaConfig
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"EmailMfaConfiguration": {
"Message": "Your OTP for MFA or sign-in: use {####}",
"Subject": "OTP test"
},
"MfaConfiguration": "OPTIONAL",
"SmsMfaConfiguration": {
"SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.",
"SmsConfiguration": {
"ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-SMS-Role",
"SnsRegion": "us-west-2"
}
},
"SoftwareTokenMfaConfiguration": {
"Enabled": true
},
"UserPoolId": "us-west-2_EXAMPLE",
"WebAuthnConfiguration": {
"RelyingPartyId": "auth.example.com",
"UserVerification": "preferred"
}
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
"EmailMfaConfiguration": {
"Message": "Your OTP for MFA or sign-in: use {####}",
"Subject": "OTP test"
},
"MfaConfiguration": "OPTIONAL",
"SmsMfaConfiguration": {
"SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.",
"SmsConfiguration": {
"ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-SMS-Role",
"SnsRegion": "us-west-2"
}
},
"SoftwareTokenMfaConfiguration": {
"Enabled": true
},
"WebAuthnConfiguration": {
"RelyingPartyId": "auth.example.com",
"UserVerification": "preferred"
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: