CreateVirtualMFADevice -

CreateVirtualMFADevice

Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see Using a virtual MFA device in the IAM User Guide.

For information about the maximum number of MFA devices you can create, see IAM and AWS STS quotas in the IAM User Guide.

Important

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

Request Syntax

{ "Path": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VirtualMFADeviceName": "string" }

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.

Path

The path for the virtual MFA device. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Required: No

Tags

A list of tags that you want to attach to the new IAM virtual MFA device. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Note

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Required: No

VirtualMFADeviceName

The name of the virtual MFA device. Use with path to uniquely identify a virtual 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.

Pattern: [\w+=,.@-]+

Required: Yes

Response Syntax

{ "VirtualMFADevice": { "Base32StringSeed": blob, "EnableDate": number, "QRCodePNG": blob, "SerialNumber": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": { "Arn": "string", "CreateDate": number, "PasswordLastUsed": number, "Path": "string", "PermissionsBoundary": { "PermissionsBoundaryArn": "string", "PermissionsBoundaryType": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "UserId": "string", "UserName": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

VirtualMFADevice

A structure containing details about the new virtual MFA device.

Type: VirtualMFADevice object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

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: 400

EntityAlreadyExistsException

The request was rejected because it attempted to create a resource that already exists.

HTTP Status Code: 400

InvalidInputException

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

LimitExceededException

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: 400

ServiceFailureException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateVirtualMFADevice.

Sample Request

https://iam.amazonaws.com/?Action=CreateVirtualMFADevice &VirtualMFADeviceName=ExampleName &Version=2010-05-08 &AUTHPARAMS

Sample Response

<CreateVirtualMFADeviceResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <CreateVirtualMFADeviceResult> <VirtualMFADevice> <SerialNumber>arn:aws:iam::123456789012:mfa/ExampleName</SerialNumber> <Base32StringSeed> 2K5K5XTLA7GGE75TQLYEXAMPLEEXAMPLEEXAMPLECHDFW4KJYZ6UFQ75LL7COCYKM </Base32StringSeed> <QRCodePNG> 89504E470D0A1A0AASDFAHSDFKJKLJFKALSDFJASDF <!-- byte array of png file --> </QRCodePNG> </VirtualMFADevice> </CreateVirtualMFADeviceResult> <ResponseMetadata> <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId> </ResponseMetadata> </CreateVirtualMFADeviceResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: