# Assign MFA devices in the Amazon CLI or Amazon API
<a name="id_credentials_mfa_enable_cliapi"></a>

You can use Amazon CLI commands or Amazon API operations to enable a virtual MFA device for an IAM user. You cannot enable an MFA device for the Amazon Web Services account root user with the Amazon CLI, Amazon API, Tools for Windows PowerShell, or any other command line tool. However, you can use the Amazon Web Services Management Console to enable an MFA device for the root user. 

When you enable an MFA device from the Amazon Web Services Management Console, the console performs multiple steps for you. If you instead create a virtual device using the Amazon CLI, Tools for Windows PowerShell, or Amazon API, then you must perform the steps manually and in the correct order. For example, to create a virtual MFA device, you must create the IAM object and extract the code as either a string or a QR code graphic. Then you must sync the device and associate it with an IAM user. See the **Examples** section of [New-IAMVirtualMFADevice](https://docs.amazonaws.cn/powershell/latest/reference/Index.html?page=New-IAMVirtualMFADevice.html&tocid=New-IAMVirtualMFADevice) for more details. For a physical device, you skip the creation step and go directly to syncing the device and associating it with the user. 

You can attach tags to your IAM resources, including virtual MFA devices, to identify, organize, and control access to them. You can tag virtual MFA devices only when you use the Amazon CLI or Amazon API.

An IAM user using the SDK or CLI can enable an additional MFA device by calling [https://docs.amazonaws.cn/IAM/latest/APIReference/API_EnableMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_EnableMFADevice.html) or deactivate an existing MFA device by calling [https://docs.amazonaws.cn/IAM/latest/APIReference/API_DeactivateMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_DeactivateMFADevice.html). To do this successfully, they must first call [https://docs.amazonaws.cn/STS/latest/APIReference/API_GetSessionToken.html](https://docs.amazonaws.cn/STS/latest/APIReference/API_GetSessionToken.html) and submit MFA codes with an existing MFA device. This call returns temporary security credentials that can then be used to sign API operations that require MFA authentication. For an example request and response, see [`GetSessionToken`—temporary credentials for users in untrusted environments](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken). 

**To create the virtual device entity in IAM to represent a virtual MFA device**  
These commands provide an ARN for the device that is used in place of a serial number in many of the following commands.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/create-virtual-mfa-device.html](https://docs.amazonaws.cn/cli/latest/reference/iam/create-virtual-mfa-device.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_CreateVirtualMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_CreateVirtualMFADevice.html) 

**To enable an MFA device for use with Amazon**  
These commands synchronize the device with Amazon and associate it with a user. If the device is virtual, use the ARN of the virtual device as the serial number.

**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 resynchronize the device using the commands described below.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/enable-mfa-device.html](https://docs.amazonaws.cn/cli/latest/reference/iam/enable-mfa-device.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_EnableMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_EnableMFADevice.html) 

**To deactivate a device**  
Use these commands to disassociate the device from the user and deactivate it. If the device is virtual, use the ARN of the virtual device as the serial number. You must also separately delete the virtual device entity. 
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/deactivate-mfa-device.html](https://docs.amazonaws.cn/cli/latest/reference/iam/deactivate-mfa-device.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_DeactivateMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_DeactivateMFADevice.html)

**To list virtual MFA device entities**  
Use these commands to list virtual MFA device entities.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/list-virtual-mfa-devices.html](https://docs.amazonaws.cn/cli/latest/reference/iam/list-virtual-mfa-devices.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_ListVirtualMFADevices.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_ListVirtualMFADevices.html) 

**To tag a virtual MFA device**  
Use these commands to tag a virtual MFA device.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/tag-mfa-device.html](https://docs.amazonaws.cn/cli/latest/reference/iam/tag-mfa-device.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_TagMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_TagMFADevice.html) 

**To list tags for a virtual MFA device**  
Use these commands to list the tags attached to a virtual MFA device.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/list-mfa-device-tags.html](https://docs.amazonaws.cn/cli/latest/reference/iam/list-mfa-device-tags.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_ListMFADeviceTags.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_ListMFADeviceTags.html) 

**To untag a virtual MFA device**  
Use these commands to remove tags attached to a virtual MFA device.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/untag-mfa-device.html](https://docs.amazonaws.cn/cli/latest/reference/iam/untag-mfa-device.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_UntagMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_UntagMFADevice.html) 

**To resynchronize an MFA device**  
Use these commands if the device is generating codes that are not accepted by Amazon. If the device is virtual, use the ARN of the virtual device as the serial number.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/resync-mfa-device.html](https://docs.amazonaws.cn/cli/latest/reference/iam/resync-mfa-device.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_ResyncMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_ResyncMFADevice.html) 

**To delete a virtual MFA device entity in IAM**  
After the device is disassociated from the user, you can delete the device entity.
+ Amazon CLI: [https://docs.amazonaws.cn/cli/latest/reference/iam/delete-virtual-mfa-device.html](https://docs.amazonaws.cn/cli/latest/reference/iam/delete-virtual-mfa-device.html) 
+ Amazon API: [https://docs.amazonaws.cn/IAM/latest/APIReference/API_DeleteVirtualMFADevice.html](https://docs.amazonaws.cn/IAM/latest/APIReference/API_DeleteVirtualMFADevice.html) 

**To recover a virtual MFA device that is lost or not working**  
Sometimes, a user's device that hosts the virtual MFA app is lost, replaced, or not working. When this happens, the user can't recover it on their own. The user must contact an administrator to deactivate the device. For more information, see [Recover an MFA protected identity in IAM](id_credentials_mfa_lost-or-broken.md).