VirtualMFADevice

Contains information about a virtual MFA device.

APIs.ioEngineeringPlatform

Properties

Name Type Description
SerialNumber object
Base32StringSeed object
QRCodePNG object
User object
EnableDate object
Tags object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-virtualmfadevice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VirtualMFADevice",
  "title": "VirtualMFADevice",
  "type": "object",
  "required": [
    "SerialNumber"
  ],
  "properties": {
    "SerialNumber": {
      "allOf": [
        {
          "$ref": "#/components/schemas/serialNumberType"
        },
        {
          "description": "The serial number associated with <code>VirtualMFADevice</code>."
        }
      ]
    },
    "Base32StringSeed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BootstrapDatum"
        },
        {
          "description": " The base32 seed defined as specified in <a href=\"https://tools.ietf.org/html/rfc3548.txt\">RFC3548</a>. The <code>Base32StringSeed</code> is base64-encoded. "
        }
      ]
    },
    "QRCodePNG": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BootstrapDatum"
        },
        {
          "description": " A QR code PNG image that encodes <code>otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String</code> where <code>$virtualMFADeviceName</code> is one of the create call arguments. <code>AccountName</code> is the user name if set (otherwise, the account ID otherwise), and <code>Base32String</code> is the seed in base32 format. The <code>Base32String</code> value is base64-encoded. "
        }
      ]
    },
    "User": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        },
        {
          "description": "The IAM user associated with this virtual MFA device."
        }
      ]
    },
    "EnableDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateType"
        },
        {
          "description": "The date and time on which the virtual MFA device was enabled."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/tagListType"
        },
        {
          "description": "A list of tags that are attached to the virtual MFA device. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html\">Tagging IAM resources</a> in the <i>IAM User Guide</i>."
        }
      ]
    }
  },
  "description": "Contains information about a virtual MFA device."
}