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.
TokenInvalidate
Indicates whether the service is capable of invalidating access tokens
TokenRefresh
Indicates whether the provider is capable of the OAuth2 token refresh.
OAuthStorageInterface
Specifies the methods required for an OAuth token storage adapter

Classes

AccessToken
Access token implementation for any OAuth version.
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
OAuthException
OAuthOptions
This class holds all settings related to the OAuth provider as well as the default HTTP client.
Amazon
Login with Amazon for Websites (OAuth2)
AzureActiveDirectory
Microsoft identity platform (OAuth2)
BattleNet
Battle.net OAuth2
BigCartel
BigCartel OAuth2
Bitbucket
Bitbucket OAuth2 (Atlassian)
Deezer
Deezer OAuth2
DeviantArt
DeviantArt OAuth2
Discogs
Discogs OAuth1
Discord
Discord OAuth2
Flickr
Flickr OAuth1
Foursquare
Foursquare 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)
ProviderException
Slack
Slack v2 OAuth2
SoundCloud
SoundCloud OAuth2
Spotify
Spotify OAuth2
SteamOpenID
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
MemoryStorage
Implements a memory storage adapter.
OAuthStorageAbstract
Implements an abstract OAuth storage adapter
OAuthStorageException
SessionStorage
Implements a session storage adapter.
AccessTokenTest
Tests the AccessToken class
DummyOAuth1Provider
An OAuth1 provider implementation
DummyOAuth2Provider
An OAuth2 provider implementation that supports token refresh, csrf tokens and client credentials
AmazonAPITest
BattleNetAPITest
BigCartelAPITest
BitbucketAPITest
DeezerAPITest
DeviantArtAPITest
DiscogsAPITest
DiscordAPITest
FlickrAPITest
FoursquareAPITest
GitHubAPITest
GitLabAPITest
GoogleAPITest
GuildWars2APITest
ImgurAPITest
LastFMAPITest
MailChimpAPITest
MastodonAPITest
MicrosoftGraphAPITest
MixcloudAPITest
MusicBrainzAPITest
NPROneAPITest
OAuth1ProviderLiveTestAbstract
OAuth2ProviderLiveTestAbstract
OAuthProviderLiveTestAbstract
OpenCachingAPITest
OpenStreetmap2APITest
OpenStreetmapAPITest
PatreonAPITest
PayPalAPITest
SlackAPITest
SoundcloudAPITest
SpotifyAPITest
SteamOpenIDAPITest
StripeAPITest
Tumblr2APITest
TumblrAPITest
TwitchAPITest
TwitterAPITest
TwitterCCAPITest
VimeoAPITest
WordpressAPITest
ProviderLiveTestAbstract
ProviderLiveTestHttpClientFactory
ProviderLiveTestMemoryStorage
Extends the standard memory storage so that it also saves tokens as JSON in the given path
ProviderTestLoggerFactory
ProviderUnitTestAbstract
ProviderUnitTestHttpClientFactory
AmazonTest
BattleNetTest
BigCartelTest
BitbucketTest
DeezerTest
DeviantArtTest
DiscogsTest
DiscordTest
FlickrTest
FoursquareTest
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
Patreon1Test
Patreon2Test
PayPalTest
SlackTest
SoundCloudTest
SpotifyTest
SteamOpenIDTest
StripeTest
Tumblr2Test
TumblrTest
TwitchTest
TwitterCCTest
TwitterTest
VimeoTest
WordPressTest
YouTubeTest
MemoryStorageTest
SessionStorageTest
StorageTestAbstract

Traits

OAuthOptionsTrait
The settings for the OAuth provider

        
On this page

Search results