MageSmith
magento/module-two-factor-auth · Magento 2.4.9

TwoFactorAuth REST endpoints

vendor/magento/module-two-factor-auth/etc/webapi.xml

25 endpoints

GET

GET

/V1/tfa/default-provider-code/:userId

Get default provider

TwoFactorAuth · Magento\TwoFactorAuth\Api\UserConfigManagerInterface::getDefaultProvider

→
GET

/V1/tfa/forced-providers

Retrieve forced providers list

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getForcedProviders

→
GET

/V1/tfa/installed-providers

Get a list of providers

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getAllProviders

→
GET

/V1/tfa/providers-to-activate/:userId

Returns a list of providers to configure/enroll

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getProvidersToActivate

→
GET

/V1/tfa/tfat-providers-to-activate

Anonymous

Get the providers that the user still needs to configure

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfatActionsInterface::getProvidersToActivate

→
GET

/V1/tfa/tfat-user-providers

Anonymous

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

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfatActionsInterface::getUserProviders

→
GET

/V1/tfa/user-providers/:userId

Get a user provider

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::getUserProviders

→

POST

POST

/V1/integration/admin/token

Anonymous

TwoFactorAuth · Magento\TwoFactorAuth\Api\AdminTokenServiceInterface::createAdminAccessToken

→
POST

/V1/tfa/provider/authy/activate

Anonymous

Activate the provider and get an admin token

TwoFactorAuth · Magento\TwoFactorAuth\Api\AuthyConfigureInterface::activate

→
POST

/V1/tfa/provider/authy/authenticate

Anonymous

Get an admin token using authy 2fa

TwoFactorAuth · Magento\TwoFactorAuth\Api\AuthyAuthenticateInterface::createAdminAccessTokenWithCredentials

→
POST

/V1/tfa/provider/authy/authenticate-onetouch

Anonymous

Authenticate using the present one touch response and get an admin token

TwoFactorAuth · Magento\TwoFactorAuth\Api\AuthyAuthenticateInterface::creatAdminAccessTokenWithOneTouch

→
POST

/V1/tfa/provider/authy/configure

Anonymous

Get the information required to configure google

TwoFactorAuth · Magento\TwoFactorAuth\Api\AuthyConfigureInterface::sendDeviceRegistrationPrompt

→
POST

/V1/tfa/provider/authy/send-token/:via

Anonymous

Send a one time password to a device using authy

TwoFactorAuth · Magento\TwoFactorAuth\Api\AuthyAuthenticateInterface::sendToken

→
POST

/V1/tfa/provider/duo_security/activate

Anonymous

Activate the provider and get an admin token

TwoFactorAuth · Magento\TwoFactorAuth\Api\DuoConfigureInterface::duoActivate

→
POST

/V1/tfa/provider/duo_security/authenticate

Anonymous

Authenticate and get an admin token with passcode

TwoFactorAuth · Magento\TwoFactorAuth\Api\DuoAuthenticateInterface::createAdminAccessTokenWithCredentialsAndPasscode

→
POST

/V1/tfa/provider/duo_security/configure

Anonymous

Configure duo for first time user

TwoFactorAuth · Magento\TwoFactorAuth\Api\DuoConfigureInterface::getDuoConfigurationData

→
POST

/V1/tfa/provider/google/activate

Anonymous

Activate the provider and get an admin token

TwoFactorAuth · Magento\TwoFactorAuth\Api\GoogleConfigureInterface::activate

→
POST

/V1/tfa/provider/google/authenticate

Anonymous

Get an admin token by authenticating using google

TwoFactorAuth · Magento\TwoFactorAuth\Api\GoogleAuthenticateInterface::createAdminAccessToken

→
POST

/V1/tfa/provider/google/configure

Anonymous

Get the information required to configure google

TwoFactorAuth · Magento\TwoFactorAuth\Api\GoogleConfigureInterface::getConfigurationData

→
POST

/V1/tfa/provider/u2fkey/activate

Anonymous

Activate the provider and get a token

TwoFactorAuth · Magento\TwoFactorAuth\Api\U2fKeyConfigureInterface::activate

→
POST

/V1/tfa/provider/u2fkey/authentication-challenge

Anonymous

Get the information to initiate a WebAuthn registration ceremony

TwoFactorAuth · Magento\TwoFactorAuth\Api\U2fKeyAuthenticateInterface::getAuthenticationData

→
POST

/V1/tfa/provider/u2fkey/configure

Anonymous

Get the information to initiate a WebAuthn registration ceremony

TwoFactorAuth · Magento\TwoFactorAuth\Api\U2fKeyConfigureInterface::getRegistrationData

→
POST

/V1/tfa/provider/u2fkey/verify

Anonymous

Authenticate with the provider and get a token

TwoFactorAuth · Magento\TwoFactorAuth\Api\U2fKeyAuthenticateInterface::createAdminAccessToken

→

PUT

PUT

/V1/tfa/default-provider-code/:userId

Set default provider code

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::setDefaultProviderCode

→
PUT

/V1/tfa/user-providers/:userId

Set providers

TwoFactorAuth · Magento\TwoFactorAuth\Api\TfaInterface::setProvidersCodes

→

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →