Log in

Integration Module

AdminTokenService

Model

This service handles OAuth token generation and revocation for admin users in Magento 2. Developers use this class when implementing custom admin auth...

AuthorizationService

Model

This service manages ACL (Access Control List) permissions for integrations in Magento 2. Developers use this class to grant specific API resources, g...

Cache\Type

Model

This class defines a dedicated cache type for storing integration configuration data in Magento 2. Developers would use this cache type when working w...

Cache\TypeConsolidated

Model

This class defines a specialized cache type for storing consolidated integration configuration data in Magento 2. Developers interact with this cache...

Cache\TypeIntegration

Model

This class defines a dedicated cache type for Integration API configurations in Magento 2. Developers interact with this cache type when managing inte...

CompositeTokenReader

Model

This class implements a composite pattern to check multiple token sources when reading user authentication tokens. Developers use this to allow flexib...

CompositeUserTokenValidator

Model

This class implements the Composite design pattern to validate user tokens by delegating to multiple validator implementations. Developers use this wh...

Config

Model

This class manages integration configurations in Magento 2, retrieving integration definitions from XML files and caching them for performance. Develo...

ConfigBasedIntegrationManager

Model

This class manages integrations that are defined in Magento's XML configuration files rather than created manually through the admin panel. Developers...

Config\AuthorizationConfig

Model

This class manages configuration settings for WebAPI authorization, specifically checking if integration access tokens can be used as bearer tokens fo...

Config\Consolidated\Converter

Model

This converter transforms integration.xml configuration files into PHP arrays that Magento can use internally. Developers use this when defining third...

Config\Consolidated\Reader

Model

This class reads and processes integration configuration from integration.xml files across Magento modules. Developers use this when Magento needs to...

Config\Consolidated\SchemaLocator

Model

This class locates and provides paths to XSD schema files used for validating integration configuration XML files in Magento 2. Developers use this cl...

Config\Converter

Model

This deprecated converter class transforms integration.xml configuration files into PHP arrays that Magento can use internally. Developers would histo...

Config\Integration\Converter

Model

This class converts XML configuration for integrations (from api.xml files) into a PHP array format that Magento can work with internally. Developers...

Config\Integration\Reader

Model

This deprecated class reads and processes integration configuration from XML files (integration/api.xml) across Magento modules. Developers would have...

Config\Integration\SchemaLocator

Model

This class locates and provides paths to XSD schema files used for validating integration configuration XML files in Magento 2. Developers would use t...

Config\Reader

Model

This class reads and parses integration configuration XML files (integration/config.xml) from Magento modules. Developers would use this to understand...

Config\SchemaLocator

Model

This class locates and provides paths to XSD schema files used for validating integration configuration XML files in Magento 2. Developers would typic...

ConsolidatedConfig

Model

This class manages the consolidated configuration for Magento 2 integrations defined in integration.xml files across all modules. It loads integration...

CredentialsValidator

Model

This validator class ensures that username and password credentials are properly provided before processing integration authentication. Developers use...

CustomUserContext

Model

This class represents a custom user context for API authentication and authorization in Magento 2. Developers use it to store and retrieve user identi...

CustomerTokenService

Model

This service manages customer authentication tokens for Magento 2's REST API. Developers use this class to generate OAuth access tokens when customers...

Integration

Model

This model represents an OAuth integration in Magento 2, storing configuration and credentials for third-party system connections. Developers use it t...

IntegrationConfig

Model

This class loads and caches integration configurations defined in XML files across Magento 2 modules. Developers use it to retrieve all configured int...

IntegrationService

Model

This service manages the complete lifecycle of Magento integrations, including creating, updating, deleting, and retrieving integration records. Devel...

Integration\Source\Status

Model

This class provides a standardized list of integration status options (Inactive, Active, Reset) for use in admin forms and grids. Developers use this...

Message\RecreatedIntegration

Model

This class displays an admin notification message when config-based integrations have been recreated and need to be reactivated. It checks all integra...

OauthService

Model

This service class manages OAuth consumer accounts and access tokens for Magento 2 integrations. Developers use it to programmatically create OAuth cr...

Oauth\Consumer

Model

This class represents an OAuth consumer entity in Magento 2's integration system. Developers use it to manage third-party applications that need to au...

Oauth\Nonce

Model

This class manages OAuth nonce values, which are unique tokens used once to prevent replay attacks in OAuth authentication. Developers use this model...

Oauth\Nonce\Generator

Model

This class generates and validates OAuth nonces and timestamps for secure API authentication in Magento 2. Developers use this to prevent replay attac...

Oauth\Token

Model

This class manages OAuth tokens in Magento 2, handling the complete OAuth token lifecycle including request tokens, access tokens, and verifier tokens...

Oauth\Token\Provider

Model

This class manages OAuth token operations for Magento 2 integrations, handling the complete OAuth 1.0a flow including request token creation, validati...

Oauth\Token\RequestThrottler

Model

This class manages OAuth token request throttling to prevent brute force attacks on admin and customer accounts. It tracks failed authentication attem...

OpaqueToken\Data

Model

This class represents opaque token metadata, storing the token's issuance and expiration timestamps. Developers use this when working with OAuth or AP...

OpaqueToken\Issuer

Model

This class creates opaque (legacy) access tokens for customer and admin users in Magento 2. Developers use this when they need to generate authenticat...

OpaqueToken\Reader

Model

This class reads and validates bearer tokens (OAuth tokens) used for API authentication in Magento 2. Developers use this class to retrieve user conte...

OpaqueToken\Revoker

Model

This class revokes OAuth access tokens for customer and admin users in Magento 2. Developers would use this when implementing security features like l...

ResourceModel\Integration

Model

This resource model manages database operations for the integration table in Magento 2. Developers use this class to retrieve active integration data,...

ResourceModel\Oauth\Consumer

Model

This resource model manages database operations for OAuth consumer entities in Magento 2's Integration module. Developers use this class when working...

ResourceModel\Oauth\Nonce

Model

This resource model manages OAuth nonce entries in the database, which are used to prevent replay attacks in OAuth authentication. Developers use this...

ResourceModel\Oauth\Token

Model

This resource model manages OAuth tokens in the database, including creating, retrieving, and deleting tokens for API authentication. Developers use t...

UserToken\ExpirationValidator

Model

This validator checks if user authentication tokens have expired by comparing their expiration timestamp with the current GMT time. It's used in Magen...

UserToken\UserTokenParameters

Model

This class holds parameters for user token generation in Magento 2's Integration system. Developers use it to pass optional configurations when creati...

Validator\BearerTokenValidator

Model

This validator determines if an integration's access token can be used as a standalone bearer token for API authentication. Developers use this when i...