openapi: 3.2.0
info:
  title: Adobe Suite Tfa/tfat User Providers API
  version: 2.4.6
  description: 'Operations tagged tfa/tfat-user-providers 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/tfat-user-providers
paths:
  /V1/tfa/tfat-user-providers:
    get:
      tags:
      - tfa/tfat-user-providers
      description: Get the providers that the user is able to use for 2fa
      operationId: GetV1TfaTfatuserproviders
      parameters:
      - name: tfaToken
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 200 Success.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/two-factor-auth-provider-interface'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/two-factor-auth-provider-interface'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
            application/xml:
              schema:
                $ref: '#/components/schemas/error-response'
      summary: tfa/tfat-user-providers
    servers:
    - url: https://example.com/rest/default
components:
  schemas:
    error-errors:
      type: array
      description: Errors list
      items:
        $ref: '#/components/schemas/error-errors-item'
    error-errors-item:
      type: object
      description: Error details
      properties:
        message:
          type: string
          description: Error message
        parameters:
          $ref: '#/components/schemas/error-parameters'
    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-provider-interface:
      type: object
      description: 2FA provider interface
      properties:
        enabled:
          type: boolean
          description: True if this provider has been enabled by admin
        engine:
          $ref: '#/components/schemas/two-factor-auth-engine-interface'
        code:
          type: string
          description: Provider code
        name:
          type: string
          description: Provider name
        icon:
          type: string
          description: Icon
        reset_allowed:
          type: boolean
          description: True if this provider configuration can be reset
        configure_action:
          type: string
          description: Configure action
        auth_action:
          type: string
          description: Auth action
        extra_actions:
          type: array
          description: Allowed extra actions
          items:
            type: string
      required:
      - enabled
      - engine
      - code
      - name
      - icon
      - reset_allowed
      - configure_action
      - auth_action
      - extra_actions
    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
    error-parameters:
      type: array
      description: Error parameters list
      items:
        $ref: '#/components/schemas/error-parameters-item'
    two-factor-auth-engine-interface:
      type: object
      description: 2FA engine interface
      properties:
        enabled:
          type: boolean
          description: True if this provider has been enabled by admin
      required:
      - enabled
  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'