openapi: 3.2.0
info:
  title: Adobe Suite Tfa/provider/authy/configure API
  version: 2.4.6
  description: 'Operations tagged tfa/provider/authy/configure across 2 of this provider''s published API definitions: adobe-suite-commerce-rest-customer-openapi.yaml, adobe-suite-commerce-rest-guest-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://example.com/rest/default
tags:
- name: tfa/provider/authy/configure
paths:
  /V1/tfa/provider/authy/configure:
    post:
      tags:
      - tfa/provider/authy/configure
      description: Get the information required to configure google
      operationId: PostV1TfaProviderAuthyConfigure
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/two-factor-auth-data-authy-registration-prompt-response-interface'
            application/xml:
              schema:
                $ref: '#/components/schemas/two-factor-auth-data-authy-registration-prompt-response-interface'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
      summary: tfa/provider/authy/configure
      requestBody:
        content:
          application/json:
            schema:
              required:
              - tfaToken
              - deviceData
              properties:
                tfaToken:
                  type: string
                deviceData:
                  $ref: '#/components/schemas/two-factor-auth-data-authy-device-interface'
              type: object
              xml:
                name: request
          application/xml:
            schema:
              required:
              - tfaToken
              - deviceData
              properties:
                tfaToken:
                  type: string
                deviceData:
                  $ref: '#/components/schemas/two-factor-auth-data-authy-device-interface'
              type: object
              xml:
                name: request
    servers:
    - url: https://example.com/rest/default
components:
  schemas:
    error-errors:
      type: array
      description: Errors list
      items:
        $ref: '#/components/schemas/error-errors-item'
    two-factor-auth-data-authy-device-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface
    error-errors-item:
      type: object
      description: Error details
      properties:
        message:
          type: string
          description: Error message
        parameters:
          $ref: '#/components/schemas/error-parameters'
    two-factor-auth-data-authy-device-interface:
      type: object
      description: Authy device data interface
      properties:
        country:
          type: string
          description: The country
        phone_number:
          type: string
          description: The phone number
        method:
          type: string
          description: The method to authenticate with
        extension_attributes:
          $ref: '#/components/schemas/two-factor-auth-data-authy-device-extension-interface'
      required:
      - country
      - phone_number
      - method
    error-response:
      type: object
      properties:
        message:
          type: string
          description: Error message
        errors:
          $ref: '#/components/schemas/error-errors'
        code:
          type: integer
          description: Error code
        parameters:
          $ref: '#/components/schemas/error-parameters'
        trace:
          type: string
          description: Stack trace
      required:
      - message
    two-factor-auth-data-authy-registration-prompt-response-extension-interface:
      type: object
      description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface
    error-parameters-item:
      type: object
      description: Error parameters item
      properties:
        resources:
          type: string
          description: ACL resource
        fieldName:
          type: string
          description: Missing or invalid field name
        fieldValue:
          type: string
          description: Incorrect field value
    two-factor-auth-data-authy-registration-prompt-response-interface:
      type: object
      description: Response for device registration prompt
      properties:
        message:
          type: string
          description: The message
        expiration_seconds:
          type: string
          description: The seconds to expire
        extension_attributes:
          $ref: '#/components/schemas/two-factor-auth-data-authy-registration-prompt-response-extension-interface'
      required:
      - message
      - expiration_seconds
    error-parameters:
      type: array
      description: Error parameters list
      items:
        $ref: '#/components/schemas/error-parameters-item'
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: header
x-refined-from:
- adobe-suite-commerce-rest-customer-openapi.yaml
- adobe-suite-commerce-rest-guest-openapi.yaml
x-original-swagger-version: '2.0'