Amazon IAM Iam Virtual Mfa Device API

openapi: 3.2.0
info:
  title: AWS Identity and Access Management Virtual Mfa Device API
  version: '2010-05-08'
  description: Generated from AWS's published Smithy model for AWS Identity and Access Management. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iam.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Virtual Mfa Device
paths:
  /?Action=CreateVirtualMFADevice:
    post:
      operationId: CreateVirtualMFADevice
      summary: Create Virtual MFADevice
      description: Creates a new virtual MFA device for the Amazon Web Services 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 STS quotas in the IAM User Guide. 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 Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateVirtualMFADeviceResponse'
        '409':
          description: ConcurrentModificationException; EntityAlreadyExistsException; LimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '400':
          description: InvalidInputException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '500':
          description: ServiceFailureException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateVirtualMFADevice
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/CreateVirtualMFADeviceRequest'
      tags:
      - Virtual Mfa Device
  /?Action=DeleteVirtualMFADevice:
    post:
      operationId: DeleteVirtualMFADevice
      summary: Delete Virtual MFADevice
      description: Deletes a virtual MFA device. You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '409':
          description: ConcurrentModificationException; DeleteConflictException; LimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
        '500':
          description: ServiceFailureException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteVirtualMFADevice
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/DeleteVirtualMFADeviceRequest'
            example:
              SerialNumber: arn:aws:iam::123456789012:mfa/ExampleName
      tags:
      - Virtual Mfa Device
  /?Action=ListVirtualMFADevices:
    post:
      operationId: ListVirtualMFADevices
      summary: List Virtual MFADevices
      description: Lists the virtual MFA devices defined in the Amazon Web Services account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view tag information for a virtual MFA device, see ListMFADeviceTags. You can paginate the results using the MaxItems and Marker parameters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListVirtualMFADevicesResponse'
              example:
                VirtualMFADevices:
                - SerialNumber: arn:aws:iam::123456789012:mfa/ExampleMFADevice
                - SerialNumber: arn:aws:iam::123456789012:mfa/Juan
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ListVirtualMFADevices
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/ListVirtualMFADevicesRequest'
      tags:
      - Virtual Mfa Device
components:
  schemas:
    CreateVirtualMFADeviceRequest:
      type: object
      properties:
        Path:
          type: string
          description: 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.
        VirtualMFADeviceName:
          type: string
          description: 'The name of the virtual MFA device, which must be unique. 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: _+=,.@-'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 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. 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.
      required:
      - VirtualMFADeviceName
    NoSuchEntityException:
      type: object
      properties:
        message:
          type: string
    ListVirtualMFADevicesRequest:
      type: object
      properties:
        AssignmentStatus:
          type: string
          enum:
          - Assigned
          - Unassigned
          - Any
          description: The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,
        Marker:
          type: string
          description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
        MaxItems:
          type: integer
          description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.
        Value:
          type: string
          description: The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
      required:
      - Key
      - Value
    ServiceFailureException:
      type: object
      properties:
        message:
          type: string
    DeleteVirtualMFADeviceRequest:
      type: object
      properties:
        SerialNumber:
          type: string
          description: 'The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the 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: =,.@:/-'
      required:
      - SerialNumber
    ListVirtualMFADevicesResponse:
      type: object
      properties:
        VirtualMFADevices:
          type: array
          items:
            $ref: '#/components/schemas/VirtualMFADevice'
          description: The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.
        IsTruncated:
          type: boolean
          description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
        Marker:
          type: string
          description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
      required:
      - VirtualMFADevices
    ConcurrentModificationException:
      type: object
      properties:
        message:
          type: string
    VirtualMFADevice:
      type: object
      properties:
        SerialNumber:
          type: string
          description: The serial number associated with VirtualMFADevice.
        Base32StringSeed:
          type: string
          format: byte
          description: The base32 seed defined as specified in RFC3548. The Base32StringSeed is base32-encoded.
        QRCodePNG:
          type: string
          format: byte
          description: A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments. AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in base32 format. The Base32String value is base64-encoded.
        User:
          $ref: '#/components/schemas/User'
        EnableDate:
          type: string
          format: date-time
          description: The date and time on which the virtual MFA device was enabled.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags that are attached to the virtual MFA device. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
      required:
      - SerialNumber
    CreateVirtualMFADeviceResponse:
      type: object
      properties:
        VirtualMFADevice:
          $ref: '#/components/schemas/VirtualMFADevice'
      required:
      - VirtualMFADevice
    AttachedPermissionsBoundary:
      type: object
      properties:
        PermissionsBoundaryType:
          type: string
          enum:
          - PermissionsBoundaryPolicy
          description: The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.
        PermissionsBoundaryArn:
          type: string
          description: The ARN of the policy used to set the permissions boundary for the user or role.
    User:
      type: object
      properties:
        Path:
          type: string
          description: The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide. The ARN of the policy used to set the permissions boundary for the user.
        UserName:
          type: string
          description: The friendly name identifying the user.
        UserId:
          type: string
          description: The stable and unique string identifying the user. For more information about IDs, see IAM identifiers in the IAM User Guide.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
        CreateDate:
          type: string
          format: date-time
          description: The date and time, in ISO 8601 date-time format, when the user was created.
        PasswordLastUsed:
          type: string
          format: date-time
          description: 'The date and time, in ISO 8601 date-time format, when the user''s password was last used to sign in to an Amazon Web Services website. For a list of Amazon Web Services websites that capture a user''s last sign-in time, see the Credential reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because: The user never had a password. A password exists but has not been used since IAM started tracking this in'
        PermissionsBoundary:
          $ref: '#/components/schemas/AttachedPermissionsBoundary'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
      required:
      - Path
      - UserName
      - UserId
      - Arn
      - CreateDate
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iam
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iam/service/2010-05-08/iam-2010-05-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)