/

POST

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

Response Example

200 - Example 1

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

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480InvalidParameterException

🟠481TooManyRequestsException

🟠482ResourceNotFoundException

🟠483NotAuthorizedException

🟠484InternalErrorException

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