/

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "SmsMfaConfiguration": {
        "SmsAuthenticationMessage": "string",
        "SmsConfiguration": {
            "SnsCallerArn": "string",
            "ExternalId": "string",
            "SnsRegion": "string"
        }
    },
    "SoftwareTokenMfaConfiguration": {
        "Enabled": true
    },
    "MfaConfiguration": "OFF"
}'

Response Example

200 - Example 1

{
    "SmsMfaConfiguration": {
        "SmsAuthenticationMessage": "string",
        "SmsConfiguration": {
            "SnsCallerArn": "string",
            "ExternalId": "string",
            "SnsRegion": "string"
        }
    },
    "SoftwareTokenMfaConfiguration": {
        "Enabled": true
    },
    "MfaConfiguration": "OFF"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

UserPoolId

string

required

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

SmsMfaConfiguration

object

optional

The SMS text message MFA configuration.

SmsAuthenticationMessage

string

optional

The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

>= 6 characters<= 140 characters

Match pattern:

.*\{####\}.*

SmsConfiguration

object

optional

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

SoftwareTokenMfaConfiguration

object

optional

The software token MFA configuration.

Enabled

boolean

optional

Specifies whether software token MFA is activated.

MfaConfiguration

enum<string>

optional

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.

Allowed values:

OFFONOPTIONAL

Examples

Responses

🟢200Success

application/json

Body

SmsMfaConfiguration

object

optional

The SMS text message MFA configuration.

SmsAuthenticationMessage

string

optional

>= 6 characters<= 140 characters

Match pattern:

.*\{####\}.*

SmsConfiguration

object

optional

SoftwareTokenMfaConfiguration

object

optional

The software token MFA configuration.

Enabled

boolean

optional

Specifies whether software token MFA is activated.

MfaConfiguration

enum<string>

optional

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.

Allowed values:

OFFONOPTIONAL

🟠480InvalidParameterException

🟠481TooManyRequestsException

🟠482ResourceNotFoundException

🟠483InvalidSmsRoleAccessPolicyException

🟠484InvalidSmsRoleTrustRelationshipException

🟠485NotAuthorizedException

🟠486InternalErrorException

Modified at 2023-08-15 07:11:07