MageSmith
443 endpoints · 37 modules · Magento 2.4.9

Magento 2 REST API Explorer

Every Magento 2 REST endpoint grouped by module, with HTTP method, path, path/query/body parameters, return types, ACL resources, and copy-paste headers, body, cURL, and JS fetch.

145 result(s) in POST · Clear

POST

/V1/braintree/mine/payment/vault

Self

BraintreeCore · PayPal\Braintree\Api\CustomerAddPaymentToVaultInterface::execute

POST

/V1/paypal/lineItems

Anonymous

BraintreeCore · PayPal\Braintree\Api\GetLineItemsAndAmountBreakDownInterface::execute

POST

/V1/paypal/oneClick

Anonymous

BraintreeCore · PayPal\Braintree\Api\PayPalOneClickInterface::execute

POST

/V1/paypal/validatePhoneNumber

Anonymous

BraintreeCore · PayPal\Braintree\Api\PhoneNumberServiceInterface::execute

POST

/V1/bundle-products/:sku/links/:optionId

Add child product to specified Bundle option by product sku

Bundle · Magento\Bundle\Api\ProductLinkManagementInterface::addChildByProductSku

POST

/V1/bundle-products/options/add

Add new option for bundle product

Bundle · Magento\Bundle\Api\ProductOptionManagementInterface::save

POST

/V1/categories

Create category service

Catalog · Magento\Catalog\Api\CategoryRepositoryInterface::save

POST

/V1/categories/:categoryId/products

Assign a product to the required category

Catalog · Magento\Catalog\Api\CategoryLinkRepositoryInterface::save

POST

/V1/products

Create product

Catalog · Magento\Catalog\Api\ProductRepositoryInterface::save

POST

/V1/products/:sku/group-prices/:customerGroupId/tiers/:qty/price/:price

Create tier price for product

Catalog · Magento\Catalog\Api\ProductTierPriceManagementInterface::add

POST

/V1/products/:sku/links

Assign a product link to another product

Catalog · Magento\Catalog\Api\ProductLinkManagementInterface::setProductLinks

POST

/V1/products/:sku/media

Create new gallery entry

Catalog · Magento\Catalog\Api\ProductAttributeMediaGalleryManagementInterface::create

POST

/V1/products/:sku/websites

Assign a product to the website

Catalog · Magento\Catalog\Api\ProductWebsiteLinkRepositoryInterface::save

POST

/V1/products/attribute-sets

Create attribute set from data

Catalog · Magento\Catalog\Api\AttributeSetManagementInterface::create

POST

/V1/products/attribute-sets/attributes

Assign attribute to attribute set

Catalog · Magento\Catalog\Api\ProductAttributeManagementInterface::assign

POST

/V1/products/attribute-sets/groups

Save attribute group

Catalog · Magento\Catalog\Api\ProductAttributeGroupRepositoryInterface::save

POST

/V1/products/attributes

Save attribute data

Catalog · Magento\Catalog\Api\ProductAttributeRepositoryInterface::save

POST

/V1/products/attributes/:attributeCode/options

Add option to attribute

Catalog · Magento\Catalog\Api\ProductAttributeOptionManagementInterface::add

POST

/V1/products/base-prices

Add or update product prices. Input item should correspond \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid price, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Catalog · Magento\Catalog\Api\BasePriceStorageInterface::update

POST

/V1/products/base-prices-information

Return product prices. In case of at least one of skus is not found exception will be thrown.

Catalog · Magento\Catalog\Api\BasePriceStorageInterface::get

POST

/V1/products/cost

Add or update product cost. Input item should correspond to \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid cost, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Catalog · Magento\Catalog\Api\CostStorageInterface::update

POST

/V1/products/cost-delete

Delete product cost. In case of at least one of skus is not found exception will be thrown. If error occurred during the delete exception will be thrown.

Catalog · Magento\Catalog\Api\CostStorageInterface::delete

POST

/V1/products/cost-information

Return product prices. In case of at least one of skus is not found exception will be thrown.

Catalog · Magento\Catalog\Api\CostStorageInterface::get

POST

/V1/products/options

Save Custom Option

Catalog · Magento\Catalog\Api\ProductCustomOptionRepositoryInterface::save

POST

/V1/products/special-price

Add or update product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Catalog · Magento\Catalog\Api\SpecialPriceStorageInterface::update

POST

/V1/products/special-price-delete

Delete product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the delete exception will be thrown.

Catalog · Magento\Catalog\Api\SpecialPriceStorageInterface::delete

POST

/V1/products/special-price-information

Return product's special price. In case of at least one of skus is not found exception will be thrown.

Catalog · Magento\Catalog\Api\SpecialPriceStorageInterface::get

POST

/V1/products/tier-prices

Add or update product prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Catalog · Magento\Catalog\Api\TierPriceStorageInterface::update

POST

/V1/products/tier-prices-delete

Delete product tier prices. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Catalog · Magento\Catalog\Api\TierPriceStorageInterface::delete

POST

/V1/products/tier-prices-information

Return product prices. In case of at least one of skus is not found exception will be thrown.

Catalog · Magento\Catalog\Api\TierPriceStorageInterface::get

POST

/V1/carts/:cartId/shipping-information

Checkout · Magento\Checkout\Api\ShippingInformationManagementInterface::saveAddressInformation

POST

/V1/carts/:cartId/totals-information

Calculate quote totals based on address and shipping method.

Checkout · Magento\Checkout\Api\TotalsInformationManagementInterface::calculate

POST

/V1/carts/mine/payment-information

Self

Set payment information and place order for a specified cart.

Checkout · Magento\Checkout\Api\PaymentInformationManagementInterface::savePaymentInformationAndPlaceOrder

POST

/V1/carts/mine/set-payment-information

Self

Set payment information for a specified cart.

Checkout · Magento\Checkout\Api\PaymentInformationManagementInterface::savePaymentInformation

POST

/V1/carts/mine/shipping-information

Self

Checkout · Magento\Checkout\Api\ShippingInformationManagementInterface::saveAddressInformation

POST

/V1/carts/mine/totals-information

Self

Calculate quote totals based on address and shipping method.

Checkout · Magento\Checkout\Api\TotalsInformationManagementInterface::calculate

POST

/V1/guest-carts/:cartId/payment-information

Anonymous

Set payment information and place order for a specified cart.

Checkout · Magento\Checkout\Api\GuestPaymentInformationManagementInterface::savePaymentInformationAndPlaceOrder

POST

/V1/guest-carts/:cartId/set-payment-information

Anonymous

Set payment information for a specified cart.

Checkout · Magento\Checkout\Api\GuestPaymentInformationManagementInterface::savePaymentInformation

POST

/V1/guest-carts/:cartId/shipping-information

Anonymous

Checkout · Magento\Checkout\Api\GuestShippingInformationManagementInterface::saveAddressInformation

POST

/V1/guest-carts/:cartId/totals-information

Anonymous

Calculate quote totals based on address and shipping method.

Checkout · Magento\Checkout\Api\GuestTotalsInformationManagementInterface::calculate

POST

/V1/cmsBlock

Save block.

Cms · Magento\Cms\Api\BlockRepositoryInterface::save

POST

/V1/cmsPage

Save page.

Cms · Magento\Cms\Api\PageRepositoryInterface::save

POST

/V1/configurable-products/:sku/child

ConfigurableProduct · Magento\ConfigurableProduct\Api\LinkManagementInterface::addChild

POST

/V1/configurable-products/:sku/options

Save option

ConfigurableProduct · Magento\ConfigurableProduct\Api\OptionRepositoryInterface::save

POST

/V1/customerGroups

Save customer group.

Customer · Magento\Customer\Api\GroupRepositoryInterface::save

POST

/V1/customers

Anonymous

Create customer account. Perform necessary business operations like sending email.

Customer · Magento\Customer\Api\AccountManagementInterface::createAccount

POST

/V1/customers/activate

Anonymous

Activate a customer account using a key that was sent in a confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::activate

POST

/V1/customers/confirm

Resend confirmation email.

Customer · Magento\Customer\Api\AccountManagementInterface::resendConfirmation

POST

/V1/customers/isEmailAvailable

Anonymous

Check if given email is associated with a customer account in given website.

Customer · Magento\Customer\Api\AccountManagementInterface::isEmailAvailable

POST

/V1/customers/resetPassword

Anonymous

Reset customer password.

Customer · Magento\Customer\Api\AccountManagementInterface::resetPassword

POST

/V1/products/:sku/downloadable-links

Update downloadable link of the given product (link type and its resources cannot be changed)

Downloadable · Magento\Downloadable\Api\LinkRepositoryInterface::save

POST

/V1/products/:sku/downloadable-links/samples

Update downloadable sample of the given product

Downloadable · Magento\Downloadable\Api\SampleRepositoryInterface::save

POST

/V1/eav/attribute-sets

Create attribute set from data

Eav · Magento\Eav\Api\AttributeSetManagementInterface::create

POST

/V1/carts/:cartId/gift-message

Set the gift message for an entire order.

GiftMessage · Magento\GiftMessage\Api\CartRepositoryInterface::save

POST

/V1/carts/:cartId/gift-message/:itemId

Set the gift message for a specified item in a specified shopping cart.

GiftMessage · Magento\GiftMessage\Api\ItemRepositoryInterface::save

POST

/V1/carts/mine/gift-message

Self

Set the gift message for an entire order.

GiftMessage · Magento\GiftMessage\Api\CartRepositoryInterface::save

POST

/V1/carts/mine/gift-message/:itemId

Self

Set the gift message for a specified item in a specified shopping cart.

GiftMessage · Magento\GiftMessage\Api\ItemRepositoryInterface::save

POST

/V1/guest-carts/:cartId/gift-message

Anonymous

Set the gift message for an entire order.

GiftMessage · Magento\GiftMessage\Api\GuestCartRepositoryInterface::save

POST

/V1/guest-carts/:cartId/gift-message/:itemId

Anonymous

Set the gift message for a specified item in a specified shopping cart.

GiftMessage · Magento\GiftMessage\Api\GuestItemRepositoryInterface::save

POST

/V1/integration/admin/token

Anonymous

Create access token for admin given the admin credentials.

Integration · Magento\Integration\Api\AdminTokenServiceInterface::createAdminAccessToken

POST

/V1/integration/customer/revoke-customer-token

Self

Revoke token by customer id.

Integration · Magento\Integration\Api\CustomerTokenServiceInterface::revokeCustomerAccessToken

POST

/V1/integration/customer/token

Anonymous

Create access token for admin given the customer credentials.

Integration · Magento\Integration\Api\CustomerTokenServiceInterface::createCustomerAccessToken

POST

/V1/inventory/source-items

Save Multiple Source item data

InventoryApi · Magento\InventoryApi\Api\SourceItemsSaveInterface::execute

POST

/V1/inventory/source-items-delete

Delete Multiple Source item data

InventoryApi · Magento\InventoryApi\Api\SourceItemsDeleteInterface::execute

POST

/V1/inventory/sources

Save Source data

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::save

POST

/V1/inventory/stock-source-links

Save StockSourceLink list data

InventoryApi · Magento\InventoryApi\Api\StockSourceLinksSaveInterface::execute

POST

/V1/inventory/stock-source-links-delete

Remove StockSourceLink list list

InventoryApi · Magento\InventoryApi\Api\StockSourceLinksDeleteInterface::execute

POST

/V1/inventory/stocks

Save Stock data

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::save

POST

/V1/inventory/bulk-partial-source-transfer

Run bulk partial inventory transfer for specified items.

InventoryCatalogApi · Magento\InventoryCatalogApi\Api\BulkPartialInventoryTransferInterface::execute

POST

/V1/inventory/bulk-product-source-assign

Run mass product to source assignment

InventoryCatalogApi · Magento\InventoryCatalogApi\Api\BulkSourceAssignInterface::execute

POST

/V1/inventory/bulk-product-source-transfer

Run bulk inventory transfer

InventoryCatalogApi · Magento\InventoryCatalogApi\Api\BulkInventoryTransferInterface::execute

POST

/V1/inventory/bulk-product-source-unassign

Run mass product to source un-assignment

InventoryCatalogApi · Magento\InventoryCatalogApi\Api\BulkSourceUnassignInterface::execute

POST

/V1/inventory/in-store-pickup/pickup-locations/

Anonymous

Get Pickup Locations according to the results of filtration by Search Request.

InventoryInStorePickupApi · Magento\InventoryInStorePickupApi\Api\GetPickupLocationsInterface::execute

POST

/V1/order/notify-orders-are-ready-for-pickup

Notify customer that the orders is ready for pickup.

InventoryInStorePickupSalesApi · Magento\InventoryInStorePickupSalesApi\Api\NotifyOrdersAreReadyForPickupInterface::execute

POST

/V1/inventory/low-quantity-notification

Save an array of SourceItemConfigurationInterface objects passed as parameter.

InventoryLowQuantityNotificationApi · Magento\InventoryLowQuantityNotificationApi\Api\SourceItemConfigurationsSaveInterface::execute

POST

/V1/inventory/low-quantity-notifications-delete

Delete multiple source items configuration for low quantity

InventoryLowQuantityNotificationApi · Magento\InventoryLowQuantityNotificationApi\Api\DeleteSourceItemsConfigurationInterface::execute

POST

/V1/inventory/source-selection-algorithm-result

Executes the source selection service using the provided inventory request and algorithm code.

InventorySourceSelectionApi · Magento\InventorySourceSelectionApi\Api\SourceSelectionServiceInterface::execute

POST

/V1/carts/mine/payment-order

Self

Create a payment order for logged in customer

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentOrderRequestInterface::create

POST

/V1/carts/mine/payment-order/:id

Self

Sync payment order for logged in customer

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentOrderRequestInterface::sync

POST

/V1/guest-carts/:cartId/payment-order

Anonymous

Create a payment order for guest customer

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentOrderRequestInterface::createGuest

POST

/V1/guest-carts/:cartId/payment-order/:id

Anonymous

Sync payment order for guest customer

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\PaymentOrderRequestInterface::syncForGuest

POST

/V1/payment-order/completeOrder

Anonymous

Rest API endpoint to place an order

PaymentServicesPaypal · Magento\PaymentServicesPaypal\Api\CompleteOrderInterface::execute

POST

/V1/carts/

Creates an empty cart and quote for a guest.

Quote · Magento\Quote\Api\CartManagementInterface::createEmptyCart

POST

/V1/carts/:cartId/billing-address

Assigns a specified billing address to a specified cart.

Quote · Magento\Quote\Api\BillingAddressManagementInterface::assign

POST

/V1/carts/:cartId/estimate-shipping-methods

Estimate shipping by address and return list of available shipping methods

Quote · Magento\Quote\Api\ShipmentEstimationInterface::estimateByExtendedAddress

POST

/V1/carts/:cartId/estimate-shipping-methods-by-address-id

Estimate shipping

Quote · Magento\Quote\Api\ShippingMethodManagementInterface::estimateByAddressId

POST

/V1/carts/:quoteId/items

Add/update the specified cart item.

Quote · Magento\Quote\Api\CartItemRepositoryInterface::save

POST

/V1/carts/mine

Self

Creates an empty cart and quote for a specified customer if customer does not have a cart yet.

Quote · Magento\Quote\Api\CartManagementInterface::createEmptyCartForCustomer

POST

/V1/carts/mine/billing-address

Self

Assigns a specified billing address to a specified cart.

Quote · Magento\Quote\Api\BillingAddressManagementInterface::assign

POST

/V1/carts/mine/estimate-shipping-methods

Self

Estimate shipping by address and return list of available shipping methods

Quote · Magento\Quote\Api\ShipmentEstimationInterface::estimateByExtendedAddress

POST

/V1/carts/mine/estimate-shipping-methods-by-address-id

Self

Estimate shipping

Quote · Magento\Quote\Api\ShippingMethodManagementInterface::estimateByAddressId

POST

/V1/carts/mine/items

Self

Add/update the specified cart item.

Quote · Magento\Quote\Api\CartItemRepositoryInterface::save

POST

/V1/customers/:customerId/carts

Creates an empty cart and quote for a specified customer if customer does not have a cart yet.

Quote · Magento\Quote\Api\CartManagementInterface::createEmptyCartForCustomer

POST

/V1/guest-carts

Anonymous

Enable an customer or guest user to create an empty cart and quote for an anonymous customer.

Quote · Magento\Quote\Api\GuestCartManagementInterface::createEmptyCart

POST

/V1/guest-carts/:cartId/billing-address

Anonymous

Assign a specified billing address to a specified cart.

Quote · Magento\Quote\Api\GuestBillingAddressManagementInterface::assign

POST

/V1/guest-carts/:cartId/estimate-shipping-methods

Anonymous

Quote · Magento\Quote\Api\GuestShipmentEstimationInterface::estimateByExtendedAddress

POST

/V1/guest-carts/:cartId/items

Anonymous

Add/update the specified cart item.

Quote · Magento\Quote\Api\GuestCartItemRepositoryInterface::save

POST

/V1/creditmemo

Performs persist operations for a specified credit memo.

Sales · Magento\Sales\Api\CreditmemoRepositoryInterface::save

POST

/V1/creditmemo/:id/comments

Performs persist operations for a specified entity.

Sales · Magento\Sales\Api\CreditmemoCommentRepositoryInterface::save

POST

/V1/creditmemo/:id/emails

Emails a user a specified credit memo.

Sales · Magento\Sales\Api\CreditmemoManagementInterface::notify

POST

/V1/creditmemo/refund

Prepare creditmemo to refund and save it.

Sales · Magento\Sales\Api\CreditmemoManagementInterface::refund

POST

/V1/invoice/:invoiceId/refund

Create refund for invoice

Sales · Magento\Sales\Api\RefundInvoiceInterface::execute

POST

/V1/invoices/

Performs persist operations for a specified invoice.

Sales · Magento\Sales\Api\InvoiceRepositoryInterface::save

POST

/V1/invoices/:id/capture

Sets invoice capture.

Sales · Magento\Sales\Api\InvoiceManagementInterface::setCapture

POST

/V1/invoices/:id/emails

Emails a user a specified invoice.

Sales · Magento\Sales\Api\InvoiceManagementInterface::notify

POST

/V1/invoices/:id/void

Voids a specified invoice.

Sales · Magento\Sales\Api\InvoiceManagementInterface::setVoid

POST

/V1/invoices/comments

Performs persist operations for a specified invoice comment.

Sales · Magento\Sales\Api\InvoiceCommentRepositoryInterface::save

POST

/V1/order/:orderId/invoice

Sales · Magento\Sales\Api\InvoiceOrderInterface::execute

POST

/V1/order/:orderId/refund

Create offline refund for order

Sales · Magento\Sales\Api\RefundOrderInterface::execute

POST

/V1/order/:orderId/ship

Creates new Shipment for given Order.

Sales · Magento\Sales\Api\ShipOrderInterface::execute

POST

/V1/orders

Performs persist operations for a specified order.

Sales · Magento\Sales\Api\OrderRepositoryInterface::save

POST

/V1/orders/:id/cancel

Cancels a specified order.

Sales · Magento\Sales\Api\OrderManagementInterface::cancel

POST

/V1/orders/:id/comments

Adds a comment to a specified order.

Sales · Magento\Sales\Api\OrderManagementInterface::addComment

POST

/V1/orders/:id/emails

Emails a user a specified order.

Sales · Magento\Sales\Api\OrderManagementInterface::notify

POST

/V1/orders/:id/hold

Holds a specified order.

Sales · Magento\Sales\Api\OrderManagementInterface::hold

POST

/V1/orders/:id/unhold

Releases a specified order from hold status.

Sales · Magento\Sales\Api\OrderManagementInterface::unHold

POST

/V1/shipment/

Performs persist operations for a specified shipment.

Sales · Magento\Sales\Api\ShipmentRepositoryInterface::save

POST

/V1/shipment/:id/comments

Performs persist operations for a specified shipment comment.

Sales · Magento\Sales\Api\ShipmentCommentRepositoryInterface::save

POST

/V1/shipment/:id/emails

Emails user a specified shipment.

Sales · Magento\Sales\Api\ShipmentManagementInterface::notify

POST

/V1/shipment/track

Performs persist operations for a specified shipment track.

Sales · Magento\Sales\Api\ShipmentTrackRepositoryInterface::save

POST

/V1/coupons

Save a coupon.

SalesRule · Magento\SalesRule\Api\CouponRepositoryInterface::save

POST

/V1/coupons/deleteByCodes

Delete coupon by coupon codes.

SalesRule · Magento\SalesRule\Api\CouponManagementInterface::deleteByCodes

POST

/V1/coupons/deleteByIds

Delete coupon by coupon ids.

SalesRule · Magento\SalesRule\Api\CouponManagementInterface::deleteByIds

POST

/V1/coupons/generate

Generate coupon for a rule

SalesRule · Magento\SalesRule\Api\CouponManagementInterface::generate

POST

/V1/salesRules

Save sales rule.

SalesRule · Magento\SalesRule\Api\RuleRepositoryInterface::save

POST

/V1/taxClasses

Create a Tax Class

Tax · Magento\Tax\Api\TaxClassRepositoryInterface::save

POST

/V1/taxRates

Create or update tax rate

Tax · Magento\Tax\Api\TaxRateRepositoryInterface::save

POST

/V1/taxRules

Save TaxRule

Tax · Magento\Tax\Api\TaxRuleRepositoryInterface::save

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

POST

/V1/customers

Create or update a customer.

Webapi · Magento\Customer\Api\CustomerRepositoryInterface::save

Last verified: against Magento 2.4.9.

Every Magento dev tool, in one hosted workspace.

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