/

POST

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "Username": "string",
    "MFAOptions": []
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

UserPoolId

string

required

The ID of the user pool that contains the user whose options you're setting.

>= 1 characters<= 55 characters

Match pattern:

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

Username

string <password>

required

The user name of the user whose options you're setting.

>= 1 characters<= 128 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

MFAOptions

array[object (MFAOptionType) {2}]

required

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

DeliveryMedium

enum<string>

optional

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Allowed values:

SMSEMAIL

AttributeName

string

optional

The attribute name of the MFA option type. The only valid value is phone_number.

>= 1 characters<= 32 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482NotAuthorizedException

🟠483UserNotFoundException

🟠484InternalErrorException

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