EnableMFADevice
Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AuthenticationCode1
-
An authentication code emitted by the device.
The format for this parameter is a string of six digits.
Important
Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.
Type: String
Length Constraints: Fixed length of 6.
Pattern:
[\d]+
Required: Yes
- AuthenticationCode2
-
A subsequent authentication code emitted by the device.
The format for this parameter is a string of six digits.
Important
Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.
Type: String
Length Constraints: Fixed length of 6.
Pattern:
[\d]+
Required: Yes
- SerialNumber
-
The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.
This parameter allows (through its regex pattern
) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/- Type: String
Length Constraints: Minimum length of 9. Maximum length of 256.
Pattern:
[\w+=/:,.@-]+
Required: Yes
- UserName
-
The name of the IAM user for whom you want to enable the MFA device.
This parameter allows (through its regex pattern
) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+
Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModification
-
The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
HTTP Status Code: 409
- EntityAlreadyExists
-
The request was rejected because it attempted to create a resource that already exists.
HTTP Status Code: 409
- EntityTemporarilyUnmodifiable
-
The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
HTTP Status Code: 409
- InvalidAuthenticationCode
-
The request was rejected because the authentication code was not recognized. The error message describes the specific error.
HTTP Status Code: 403
- LimitExceeded
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
HTTP Status Code: 409
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of EnableMFADevice.
Sample Request
https://iam.amazonaws.com/?Action=EnableMFADevice
&UserName=Bob
&SerialNumber=R1234
&AuthenticationCode1=234567
&AuthenticationCode2=987654
&Version=2010-05-08
&AUTHPARAMS
Sample Response
<EnableMFADeviceResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
</ResponseMetadata>
</EnableMFADeviceResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: