Documentation

Application

Table of Contents

Interfaces

ClientCredentials: Indicates whether the provider is capable of the OAuth2 client credentials authentication flow.
CSRFToken: Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
OAuth1Interface: Specifies the basic methods for an OAuth1 provider.
OAuth2Interface: Specifies the basic methods for an OAuth2 provider.
OAuthInterface: Specifies the basic methods for an OAuth provider.
PAR: Specifies the methods required for the OAuth2 Pushed Authorization Requests (PAR)
PKCE: Specifies the methods required for the OAuth2 Proof Key for Code Exchange (PKCE)
TokenInvalidate: Indicates whether the provider is capable of invalidating access tokens
TokenRefresh: Indicates whether the provider is capable of the OAuth2 token refresh.
UserInfo: This nterface indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
OAuthStorageInterface: Specifies the methods required for an OAuth token storage adapter

Classes

AccessToken: Access token implementation for any OAuth version.
AuthenticatedUser: A simple read-only container for user data responses from `OAuthInterface::me()`
CSRFStateMismatchException
InvalidAccessTokenException
OAuth1Provider: Implements an abstract OAuth1 (1.0a) provider with all methods required by the OAuth1Interface.
OAuth2Provider: Implements an abstract OAuth2 provider with all methods required by the OAuth2Interface.
OAuthProvider: Implements an abstract OAuth provider with all methods required by the OAuthInterface.
UnauthorizedAccessException
Utilities: Common utilities for use with the OAuth providers
OAuthException
OAuthOptions: This class holds all settings related to the OAuth provider as well as the default HTTP client.
OAuthProviderFactory: A simple OAuth provider factory (not sure if that clears the mess...)
Amazon: Login with Amazon for Websites (OAuth2)
AzureActiveDirectory: Microsoft identity platform (OAuth2)
BattleNet: Battle.net OAuth2
BigCartel: BigCartel OAuth2
Bitbucket: Bitbucket OAuth2 (Atlassian)
Codeberg: Codeberg OAuth2
Deezer: Deezer OAuth2
DeviantArt: DeviantArt OAuth2
Discogs: Discogs OAuth1
Discord: Discord OAuth2
Flickr: Flickr OAuth1
Foursquare: Foursquare OAuth2
Gitea: Gitea OAuth2
GitHub: GitHub OAuth2
GitLab: GitLab OAuth2
Google: Google OAuth2
GuildWars2: Guild Wars 2
Imgur: Imgur OAuth2
LastFM: Last.fm
MailChimp: MailChimp OAuth2
Mastodon: Mastodon OAuth2 (v4.x instances)
MicrosoftGraph: Microsoft Graph OAuth2
Mixcloud: Mixcloud OAuth2
MusicBrainz: MusicBrainz OAuth2
NPROne: NPR API services (OAuth2)
OpenCaching: Opencaching OAuth1
OpenStreetmap: OpenStreetmap OAuth1 (deprecated)
OpenStreetmap2: OpenStreetmap OAuth2
Patreon: Patreon v2 OAuth2
PayPal: PayPal OAuth2
PayPalSandbox: PayPal OAuth2 (sandbox)
Pinterest: Pinterest OAuth2
ProviderException
Reddit: Reddit OAuth2
Slack: Slack v2 OAuth2
SoundCloud: SoundCloud OAuth2
Spotify: Spotify OAuth2
Steam: Steam OpenID
Stripe: Stripe OAuth2
Tumblr: Tumblr OAuth1
Tumblr2: Tumblr OAuth2
Twitch: Twitch OAuth2
Twitter: Twitter OAuth1
TwitterCC: Twitter OAuth2 (client credentials)
Vimeo: Vimeo OAuth2
WordPress: WordPress OAuth2
YouTube: YouTube OAuth2
FileStorage: Implements a filesystem storage adapter.
MemoryStorage: Implements a memory storage adapter.
OAuthStorageAbstract: Implements an abstract OAuth storage adapter
OAuthStorageException
SessionStorage: Implements a session storage adapter.
StateNotFoundException
TokenNotFoundException
VerifierNotFoundException
Provider: Supplies the provider class name
AccessTokenTest: Tests the AccessToken class
AuthenticatedUserTest
OAuthOptionsTest
OAuthProviderFactoryTest
UtilitiesTest
DummyOAuth1Provider: An OAuth1 provider implementation
DummyOAuth2Provider: An OAuth2 provider implementation that supports token refresh, csrf tokens and client credentials
AmazonAPITest
BattleNetAPITest
BigCartelAPITest
BitbucketAPITest
CodebergAPITest
DeezerAPITest
DeviantArtAPITest
DiscogsAPITest
DiscordAPITest
FlickrAPITest
FoursquareAPITest
GiteaAPITest
GitHubAPITest
GitLabAPITest
GoogleAPITest
GuildWars2APITest
ImgurAPITest
LastFMAPITest
MailChimpAPITest
MastodonAPITest
MicrosoftGraphAPITest
MixcloudAPITest
MusicBrainzAPITest
NPROneAPITest
OAuth1ProviderLiveTestAbstract
OAuth2ProviderLiveTestAbstract
OAuthProviderLiveTestAbstract
OpenCachingAPITest
OpenStreetmap2APITest
OpenStreetmapAPITest
PatreonAPITest
PayPalAPITest
PinterestAPITest
RedditAPITest
SlackAPITest
SoundcloudAPITest
SpotifyAPITest
SteamAPITest
StripeAPITest
Tumblr2APITest
TumblrAPITest
TwitchAPITest
TwitterAPITest
TwitterCCAPITest
VimeoAPITest
WordpressAPITest
YouTubeAPITest
ProviderLiveTestAbstract
ProviderLiveTestHttpClientFactory
ProviderTestLoggerFactory
ProviderUnitTestAbstract
ProviderUnitTestHttpClientFactory
AmazonTest
BattleNetTest
BigCartelTest
BitbucketTest
CodebergTest
DeezerTest
DeviantArtTest
DiscogsTest
DiscordTest
FlickrTest
FoursquareTest
GiteaTest
GitHubTest
GitLabTest
GoogleTest
GuildWars2Test
ImgurTest
LastFMTest
MailChimpTest
MastodonTest
MicrosoftGraphTest
MixcloudTest
MusicBrainzTest
NPROneTest
OAuth1ProviderUnitTestAbstract
OAuth1Test: The built-in dummy test for OAuth1
OAuth2ProviderUnitTestAbstract
OAuth2Test: The built-in dummy test for OAuth2
OAuthProviderUnitTestAbstract
OpenCachingTest
OpenStreetmap2Test
OpenStreetmapTest
PatreonTest
PayPalTest
PinterestTest
RedditTest
SlackTest
SoundCloudTest
SpotifyTest
SteamTest
StripeTest
Tumblr2Test
TumblrTest
TwitchTest
TwitterCCTest
TwitterTest
VimeoTest
WordPressTest
YouTubeTest
FileStorageEncryptedTest: Tests the file storage (encrypted)
FileStorageTest: Tests the file storage
MemoryStorageTest
SessionStorageEncryptedTest: Tests the session storage (encrypted)
SessionStorageTest: Tests the session storage
StorageTestAbstract

Traits

OAuthOptionsTrait: The settings for the OAuth provider

On this page

Table Of Contents