Integration Module
AdminTokenService
This service handles OAuth token generation and revocation for admin users in Magento 2. Developers use this class when implementing custom admin auth...
Api\AdminTokenServiceInterface
This interface defines token-based authentication services for Magento admin users. Developers use this to programmatically generate OAuth access toke...
Api\AuthorizationServiceInterface
This interface defines the contract for managing API permissions and access control for integrations in Magento 2. Developers use this service to gran...
Api\CustomerTokenServiceInterface
This interface defines the contract for managing customer authentication tokens in Magento 2's REST API. Developers use this service to create OAuth a...
Api\Data\UserToken
This class represents a user authentication token in Magento 2's integration system. It encapsulates both the user's context (user ID, type, and permi...
Api\Data\UserTokenDataInterface
This interface defines the contract for retrieving metadata about user authentication tokens in Magento 2. Developers use this to access when a token...
Api\Data\UserTokenParametersInterface
This interface defines parameters that can be passed when creating new user authentication tokens in Magento 2. Developers use this to customize token...
Api\Exception\UserTokenException
This exception class is thrown when there are failures related to user authentication tokens in Magento's integration system. Developers should catch...
Api\IntegrationServiceInterface
This interface defines the contract for managing Magento 2 integrations, which are used to connect third-party systems with the store via API. Develop...
Api\OauthServiceInterface
This interface defines the contract for managing OAuth authentication in Magento 2 integrations. Developers use this service to create and manage OAut...
Api\TokenManager
This class manages authentication tokens for Magento users by providing a unified interface to create and revoke user tokens. Developers use it when i...
Api\UserTokenIssuerInterface
This interface defines a contract for issuing authentication tokens for Magento users. Developers would implement this interface when creating custom...
Api\UserTokenReaderInterface
This interface defines a contract for reading and extracting user data from authentication tokens. Developers would use implementations of this interf...
Api\UserTokenRevokerInterface
This interface defines a contract for revoking authentication tokens for Magento users. Developers would implement this interface to create services t...
Api\UserTokenValidatorInterface
This interface defines a contract for validating user authentication tokens in Magento 2. Developers implement this interface to create custom token v...
AuthorizationService
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
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
This class defines a specialized cache type for storing consolidated integration configuration data in Magento 2. Developers interact with this cache...
Cache\TypeIntegration
This class defines a dedicated cache type for Integration API configurations in Magento 2. Developers interact with this cache type when managing inte...
CompositeTokenReader
This class implements a composite pattern to check multiple token sources when reading user authentication tokens. Developers use this to allow flexib...
CompositeUserTokenValidator
This class implements the Composite design pattern to validate user tokens by delegating to multiple validator implementations. Developers use this wh...
Config
This class manages integration configurations in Magento 2, retrieving integration definitions from XML files and caching them for performance. Develo...
ConfigBasedIntegrationManager
This class manages integrations that are defined in Magento's XML configuration files rather than created manually through the admin panel. Developers...
Config\AuthorizationConfig
This class manages configuration settings for WebAPI authorization, specifically checking if integration access tokens can be used as bearer tokens fo...
Config\Consolidated\Converter
This converter transforms integration.xml configuration files into PHP arrays that Magento can use internally. Developers use this when defining third...
Config\Consolidated\Reader
This class reads and processes integration configuration from integration.xml files across Magento modules. Developers use this when Magento needs to...
Config\Consolidated\SchemaLocator
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
This deprecated converter class transforms integration.xml configuration files into PHP arrays that Magento can use internally. Developers would histo...
Config\Integration\Converter
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
This deprecated class reads and processes integration configuration from XML files (integration/api.xml) across Magento modules. Developers would have...
Config\Integration\SchemaLocator
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
This class reads and parses integration configuration XML files (integration/config.xml) from Magento modules. Developers would use this to understand...
Config\SchemaLocator
This class locates and provides paths to XSD schema files used for validating integration configuration XML files in Magento 2. Developers would typic...
ConsolidatedConfig
This class manages the consolidated configuration for Magento 2 integrations defined in integration.xml files across all modules. It loads integration...
CredentialsValidator
This validator class ensures that username and password credentials are properly provided before processing integration authentication. Developers use...
CustomUserContext
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
This service manages customer authentication tokens for Magento 2's REST API. Developers use this class to generate OAuth access tokens when customers...
Data
This helper class provides utility functions for working with integrations in Magento 2. Developers use it to transform ACL resource arrays into a jsT...
Integration
This model represents an OAuth integration in Magento 2, storing configuration and credentials for third-party system connections. Developers use it t...
IntegrationConfig
This class loads and caches integration configurations defined in XML files across Magento 2 modules. Developers use it to retrieve all configured int...
IntegrationService
This service manages the complete lifecycle of Magento integrations, including creating, updating, deleting, and retrieving integration records. Devel...
Integration\Source\Status
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
This class displays an admin notification message when config-based integrations have been recreated and need to be reactivated. It checks all integra...
Model\ResourceModel\Integration\Collection
This collection class manages and retrieves groups of Integration records from the database. Developers use this class to load multiple integrations a...
OauthService
This service class manages OAuth consumer accounts and access tokens for Magento 2 integrations. Developers use it to programmatically create OAuth cr...
Oauth\Consumer
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\Data
This helper class provides configuration access methods for OAuth-related settings in Magento 2, including token lifetimes, cleanup settings, and cons...
Oauth\Nonce
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
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
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
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
This class manages OAuth token request throttling to prevent brute force attacks on admin and customer accounts. It tracks failed authentication attem...
OpaqueToken\Data
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
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
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
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
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
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
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
This resource model manages OAuth tokens in the database, including creating, retrieving, and deleting tokens for API authentication. Developers use t...
UserToken\ExpirationValidator
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
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
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...