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

GET /V1/tfa/tfat-user-providers

Query parameters

tfaToken string Required

Responses

200

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
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  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 \
 -X 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 (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}