Get the providers that the user is able to use for 2fa

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Magento2 MCP server": {
    "url": "https://magento2.doc.winkelstraat.nl/mcp"
  }
}

Close
GET /V1/tfa/tfat-user-providers

Get the providers that the user is able to use for 2fa

Query parameters

  • tfaToken string Required

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • enabled boolean Required

      True if this provider has been enabled by admin

    • engine object Required

      2FA engine interface

      Hide engine attribute Show engine attribute object
      • enabled boolean Required

        True if this provider has been enabled by admin

    • code string Required

      Provider code

    • name string Required

      Provider name

    • icon string Required

      Icon

    • reset_allowed boolean Required

      True if this provider configuration can be reset

    • configure_action string Required

      Configure action

    • auth_action string Required

      Auth action

    • extra_actions array[string] Required

      Allowed extra actions

    Hide response attributes Show response attributes object
    • enabled boolean Required

      True if this provider has been enabled by admin

    • engine object Required

      2FA engine interface

      Hide engine attribute Show engine attribute object
      • enabled boolean Required

        True if this provider has been enabled by admin

    • code string Required

      Provider code

    • name string Required

      Provider name

    • icon string Required

      Icon

    • reset_allowed boolean Required

      True if this provider configuration can be reset

    • configure_action string Required

      Configure action

    • auth_action string Required

      Auth action

    • extra_actions array[string] Required

      Allowed extra actions

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/tfa/tfat-user-providers
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/tfa/tfat-user-providers?tfaToken=string'
Response examples (200)
[
  {
    "enabled": true,
    "engine": {
      "enabled": true
    },
    "code": "string",
    "name": "string",
    "icon": "string",
    "reset_allowed": true,
    "configure_action": "string",
    "auth_action": "string",
    "extra_actions": [
      "string"
    ]
  }
]
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <enabled type="boolean">true</enabled>
    <engine>
      <enabled type="boolean">true</enabled>
    </engine>
    <code>string</code>
    <name>string</name>
    <icon>string</icon>
    <reset-allowed type="boolean">true</reset-allowed>
    <configure-action>string</configure-action>
    <auth-action>string</auth-action>
    <extra-actions type="array">
      <extra-action>string</extra-action>
    </extra-actions>
  </root>
</root>
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>