SetUserMFAPreference
Set the user's multi-factor authentication (MFA) method preference.
Request Syntax
{ "AccessToken": "string", "SMSMfaSettings": { "Enabled":boolean, "PreferredMfa":boolean}, "SoftwareTokenMfaSettings": { "Enabled":boolean, "PreferredMfa":boolean} }
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.
- AccessToken
-
The access token.
Type: String
Pattern:
[A-Za-z0-9-_=.]+Required: Yes
- SMSMfaSettings
-
The SMS text message multi-factor authentication (MFA) settings.
Type: SMSMfaSettingsType object
Required: No
- SoftwareTokenMfaSettings
-
The time-based one-time password software token MFA settings.
Type: SoftwareTokenMfaSettingsType object
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
- NotAuthorizedException
-
This exception is thrown when a user is not authorized.
HTTP Status Code: 400
- PasswordResetRequiredException
-
This exception is thrown when a password reset is required.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
HTTP Status Code: 400
- UserNotConfirmedException
-
This exception is thrown when a user is not confirmed successfully.
HTTP Status Code: 400
- UserNotFoundException
-
This exception is thrown when a user is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
