Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

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 SetUserMFAPreference instead.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AccessToken": "string",
    "MFAOptions": []
}'
Response Response Example
200 - Example 1
{}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
Represents the request to set user settings.
AccessToken
string <password>
required
A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
Match pattern:
[A-Za-z0-9-_=.]+
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
🟠483PasswordResetRequiredException
🟠484UserNotFoundException
🟠485UserNotConfirmedException
🟠486InternalErrorException
🟠487ForbiddenException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with