MFA Devices

/**
 * Creates a new virtual MFA device for the AWS account
 * @param VirtualMFADeviceName - The name of the virtual MFA device
 * @param Path - The path for the virtual MFA device (default: /)
 */
interface CreateVirtualMFADeviceCommandInput {
  VirtualMFADeviceName: string;
  Path?: string;
}

interface CreateVirtualMFADeviceCommandOutput {
  VirtualMFADevice?: VirtualMFADevice;
}

import { IAMClient, CreateVirtualMFADeviceCommand } from "@aws-sdk/client-iam";

const client = new IAMClient({ region: "us-east-1" });

const command = new CreateVirtualMFADeviceCommand({
  VirtualMFADeviceName: "MyVirtualMFADevice",
  Path: "/mfa/"
});

const result = await client.send(command);
console.log("MFA Device created:", result.VirtualMFADevice?.SerialNumber);

/**
 * Enables the specified MFA device and associates it with the specified IAM user
 * @param UserName - The name of the IAM user
 * @param SerialNumber - The serial number that uniquely identifies the MFA device
 * @param AuthenticationCode1 - First authentication code emitted by the device
 * @param AuthenticationCode2 - Second authentication code emitted by the device
 */
interface EnableMFADeviceCommandInput {
  UserName: string;
  SerialNumber: string;
  AuthenticationCode1: string;
  AuthenticationCode2: string;
}

import { IAMClient, EnableMFADeviceCommand } from "@aws-sdk/client-iam";

const command = new EnableMFADeviceCommand({
  UserName: "test-user",
  SerialNumber: "arn:aws:iam::123456789012:mfa/MyVirtualMFADevice",
  AuthenticationCode1: "123456", // Current TOTP code
  AuthenticationCode2: "789012"  // Next TOTP code (after 30 seconds)
});

await client.send(command);

/**
 * Deactivates the specified MFA device and removes it from the IAM user
 * @param UserName - The name of the user whose MFA device you want to deactivate
 * @param SerialNumber - The serial number that uniquely identifies the MFA device
 */
interface DeactivateMFADeviceCommandInput {
  UserName?: string;
  SerialNumber: string;
}

/**
 * Deletes a virtual MFA device
 * @param SerialNumber - The serial number that uniquely identifies the MFA device
 */
interface DeleteVirtualMFADeviceCommandInput {
  SerialNumber: string;
}

/**
 * Lists the MFA devices for an IAM user
 * @param UserName - The name of the user whose MFA devices you want to list
 * @param Marker - Use this parameter only when paginating results
 * @param MaxItems - Maximum number of items to return
 */
interface ListMFADevicesCommandInput {
  UserName?: string;
  Marker?: string;
  MaxItems?: number;
}

interface ListMFADevicesCommandOutput {
  MFADevices: MFADevice[];
  IsTruncated?: boolean;
  Marker?: string;
}

/**
 * Lists the virtual MFA devices defined in the AWS account
 * @param AssignmentStatus - The status (Unassigned, Assigned, or Any) of the devices to list
 * @param Marker - Use this parameter only when paginating results
 * @param MaxItems - Maximum number of items to return
 */
interface ListVirtualMFADevicesCommandInput {
  AssignmentStatus?: AssignmentStatusType;
  Marker?: string;
  MaxItems?: number;
}

interface ListVirtualMFADevicesCommandOutput {
  VirtualMFADevices: VirtualMFADevice[];
  IsTruncated?: boolean;
  Marker?: string;
}

/**
 * Retrieves information about the specified MFA device
 * @param SerialNumber - Serial number that uniquely identifies the MFA device
 * @param UserName - The friendly name identifying the user
 */
interface GetMFADeviceCommandInput {
  SerialNumber: string;
  UserName?: string;
}

interface GetMFADeviceCommandOutput {
  SerialNumber: string;
  UserName?: string;
  EnableDate?: Date;
}

/**
 * Synchronizes the specified MFA device with its IAM resource object
 * @param UserName - The name of the user whose MFA device you want to resynchronize
 * @param SerialNumber - Serial number that uniquely identifies the MFA device
 * @param AuthenticationCode1 - An authentication code emitted by the device
 * @param AuthenticationCode2 - A subsequent authentication code emitted by the device
 */
interface ResyncMFADeviceCommandInput {
  UserName: string;
  SerialNumber: string;
  AuthenticationCode1: string;
  AuthenticationCode2: string;
}

/**
 * Adds one or more tags to an IAM virtual MFA device
 * @param SerialNumber - The unique identifier for the IAM virtual MFA device
 * @param Tags - The list of tags to attach to the MFA device
 */
interface TagMFADeviceCommandInput {
  SerialNumber: string;
  Tags: Tag[];
}

/**
 * Removes the specified tags from the IAM virtual MFA device
 * @param SerialNumber - The unique identifier for the IAM virtual MFA device
 * @param TagKeys - A list of key names as a simple array of strings
 */
interface UntagMFADeviceCommandInput {
  SerialNumber: string;
  TagKeys: string[];
}

/**
 * Lists the tags attached to the specified IAM virtual MFA device
 * @param SerialNumber - The unique identifier for the IAM virtual MFA device
 * @param Marker - Use this parameter only when paginating results
 * @param MaxItems - Maximum number of items to return
 */
interface ListMFADeviceTagsCommandInput {
  SerialNumber: string;
  Marker?: string;
  MaxItems?: number;
}

interface VirtualMFADevice {
  SerialNumber: string;
  Base32StringSeed?: Uint8Array;
  QRCodePNG?: Uint8Array;
  User?: User;
  EnableDate?: Date;
  Tags?: Tag[];
}

interface MFADevice {
  UserName: string;
  SerialNumber: string;
  EnableDate: Date;
}

enum AssignmentStatusType {
  Assigned = "Assigned",
  Unassigned = "Unassigned",
  Any = "Any"
}