Get a user provider

GET /V1/tfa/user-providers/{userId}

Get a user provider

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
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/tfa/user-providers/{userId} 
curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/tfa/user-providers/{userId}
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 (401) 
{
  "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) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}