From 6155174b4bca268ff3ee6401867d1d707d9ba7c9 Mon Sep 17 00:00:00 2001 From: codemasher Date: Sun, 19 May 2024 01:48:06 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20chillerl?= =?UTF-8?q?an/php-oauth@9aeed31993811c46864eed7bc944ddc8a9af9354=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../chillerlan-OAuth-Core-OAuth2Provider.html | 338 +++++++++++--- ...chillerlan-OAuth-Core-TokenInvalidate.html | 29 +- .../chillerlan-OAuth-Providers-Amazon.html | 334 ++++++++++++-- ...-OAuth-Providers-AzureActiveDirectory.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-BattleNet.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-BigCartel.html | 337 ++++++++++---- .../chillerlan-OAuth-Providers-Bitbucket.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Codeberg.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Deezer.html | 322 +++++++++++-- ...chillerlan-OAuth-Providers-DeviantArt.html | 337 ++++++++++---- .../chillerlan-OAuth-Providers-Discord.html | 339 ++++++++++---- ...chillerlan-OAuth-Providers-Foursquare.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-GitHub.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-GitLab.html | 334 ++++++++++++-- classes/chillerlan-OAuth-Providers-Gitea.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Google.html | 334 ++++++++++++-- ...chillerlan-OAuth-Providers-GuildWars2.html | 326 ++++++++++++-- classes/chillerlan-OAuth-Providers-Imgur.html | 330 ++++++++++++-- .../chillerlan-OAuth-Providers-MailChimp.html | 330 ++++++++++++-- .../chillerlan-OAuth-Providers-Mastodon.html | 330 ++++++++++++-- ...lerlan-OAuth-Providers-MicrosoftGraph.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Mixcloud.html | 334 ++++++++++++-- ...hillerlan-OAuth-Providers-MusicBrainz.html | 328 ++++++++++---- .../chillerlan-OAuth-Providers-NPROne.html | 330 ++++++++++---- ...lerlan-OAuth-Providers-OpenStreetmap2.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Patreon.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-PayPal.html | 334 ++++++++++++-- ...llerlan-OAuth-Providers-PayPalSandbox.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Pinterest.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Reddit.html | 424 ++++++++++++------ classes/chillerlan-OAuth-Providers-Slack.html | 334 ++++++++++++-- ...chillerlan-OAuth-Providers-SoundCloud.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Spotify.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Stripe.html | 328 ++++++++++---- .../chillerlan-OAuth-Providers-Tumblr2.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-Twitch.html | 320 +++++++++---- .../chillerlan-OAuth-Providers-TwitterCC.html | 322 +++++++++++-- classes/chillerlan-OAuth-Providers-Vimeo.html | 333 ++++++++++---- .../chillerlan-OAuth-Providers-WordPress.html | 334 ++++++++++++-- .../chillerlan-OAuth-Providers-YouTube.html | 334 ++++++++++++-- ...uthTest-Providers-DummyOAuth1Provider.html | 11 +- ...uthTest-Providers-DummyOAuth2Provider.html | 337 ++++++++++---- ...n-OAuthTest-Providers-Unit-StripeTest.html | 10 +- files/src-core-tokeninvalidate.html | 2 +- files/src/Core/OAuth2Provider.php.txt | 78 +++- js/searchIndex.js | 83 ++-- namespaces/chillerlan-oauth-core.html | 2 +- packages/Application.html | 2 +- 48 files changed, 11261 insertions(+), 2349 deletions(-) diff --git a/classes/chillerlan-OAuth-Core-OAuth2Provider.html b/classes/chillerlan-OAuth-Core-OAuth2Provider.html index dceed95..6522840 100644 --- a/classes/chillerlan-OAuth-Core-OAuth2Provider.html +++ b/classes/chillerlan-OAuth-Core-OAuth2Provider.html @@ -154,9 +154,9 @@

Implements an abstract OAuth2 provider with all methods required by the OAuth2Interface.

@@ -469,6 +469,12 @@

 : bool +
+ invalidateAccessToken() + +  : bool +
+
refreshAccessToken() @@ -606,6 +612,13 @@

prepares the request body parameters for the client credentials token request
+
+ getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
+
Prepares the body for a token revocation request
+
getMeResponseData() @@ -698,6 +711,13 @@

prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
+
+ sendTokenInvalidateRequest() + +  : ResponseInterface +
+
Prepares and sends a request to the token invalidation endpoint
+
setRequestBody() @@ -911,9 +931,9 @@

An optional client credentials token endpoint in case the provider supports ClientCredentials.

@@ -1103,9 +1123,9 @@

An optional PAR (Pushed Authorization Request) endpoint URL

@@ -1153,9 +1173,9 @@

An optional refresh token endpoint in case the provider supports TokenRefresh.

@@ -1520,9 +1540,9 @@

@@ -1594,9 +1614,9 @@

@@ -1671,9 +1691,9 @@

@@ -1750,9 +1770,9 @@

Obtains an OAuth2 access token with the given $code, verifies the $state @@ -1993,9 +2013,9 @@

@@ -2060,9 +2080,9 @@

@@ -2188,9 +2208,9 @@

@@ -2258,9 +2278,9 @@

@@ -2503,6 +2523,83 @@

Return values
bool + +
+

+ invalidateAccessToken() + + +

+ + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
+
+ +
Parameters
+
+
+ $token + : AccessToken + = null
+
+ +
+
+ $type + : string|null + = null
+
+ +
+
+ + +
+ Tags + + +
+
+
+ implements +
+
+ +

\chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

+
+ +
+
+ throws +
+
+ ProviderException + + +
+
+ +
+
Return values
+ bool +
+
@@ -2761,9 +2858,9 @@

@@ -2838,9 +2935,9 @@

@@ -3044,9 +3141,9 @@

@@ -3620,9 +3717,9 @@

OAuth2Provider.php : - 210 + 211 - +

prepares the request body parameters for the access token request

@@ -3682,9 +3779,9 @@

OAuth2Provider.php : - 75 + 76 - +

prepares the query parameters for the auth URL

@@ -3751,9 +3848,9 @@

OAuth2Provider.php : - 323 + 324 - +

prepares the request body parameters for the client credentials token request

@@ -3798,6 +3895,75 @@

Return values
array<string|int, mixed> +
+
+

+ getInvalidateAccessTokenBodyParams() + + +

+ + +

Prepares the body for a token revocation request

+ + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
+
+ +
Parameters
+
+
+ $token + : AccessToken +
+
+ +
+
+ $type + : string +
+
+ +
+
+ + +
+ Tags + + +
+
+
+ see +
+
+ OAuth2Provider::invalidateAccessToken() + + +
+
+ +
+
Return values
+ array<string|int, mixed> +
+
OAuth2Provider.php : - 595 + 671 - +

Parses the response from the PAR request and returns the query parameters for the authorization URL

@@ -3975,9 +4141,9 @@

OAuth2Provider.php : - 399 + 400 - +

prepares the request body parameters for the token refresh

@@ -4211,9 +4377,9 @@

extracts the data from the access token response and returns an array with the key->value pairs contained

@@ -4417,9 +4583,9 @@

Parses the response from a request to the token endpoint

@@ -4517,9 +4683,9 @@

sends a request to the access/refresh token endpoint $url with the given $body as form data

@@ -4602,9 +4768,9 @@

OAuth2Provider.php : - 338 + 339 - +

sends a request to the client credentials endpoint, using basic authentication

@@ -4705,6 +4871,75 @@

Parameters
+
+
Return values
+ ResponseInterface +
+ +
+
+

+ sendTokenInvalidateRequest() + + +

+ + +

Prepares and sends a request to the token invalidation endpoint

+ + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
+
+ +
Parameters
+
+
+ $url + : string +
+
+ +
+
+ $body + : array<string|int, mixed> +
+
+ +
+
+ + +
+ Tags + + +
+
+
+ see +
+
+ OAuth2Provider::invalidateAccessToken() + + +
+
+
Return values
ResponseInterface @@ -4933,6 +5168,7 @@
Return values
  • getStorage()
  • getUserRevokeURL()
  • InvalidateAccessToken()
    • +
  • invalidateAccessToken()
  • refreshAccessToken()
  • request()
  • sendRequest()
    • @@ -4953,6 +5189,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -4966,6 +5203,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Core-TokenInvalidate.html b/classes/chillerlan-OAuth-Core-TokenInvalidate.html index 949b016..35c7f13 100644 --- a/classes/chillerlan-OAuth-Core-TokenInvalidate.html +++ b/classes/chillerlan-OAuth-Core-TokenInvalidate.html @@ -137,14 +137,28 @@

    -

    Indicates whether the provider is capable of invalidating access tokens

    +

    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)

    +

    + Tags + + +
    +
    +
    + link +
    +
    + https://datatracker.ietf.org/doc/html/rfc7009 + +
    +
    @@ -203,7 +217,7 @@

    @@ -211,7 +225,7 @@

    public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ][, string|null $type = null ]) : bool
    @@ -230,6 +244,13 @@

    Parameters
    = null
    +
    +
    + $type + : string|null + = null
    +
    +
    diff --git a/classes/chillerlan-OAuth-Providers-Amazon.html b/classes/chillerlan-OAuth-Providers-Amazon.html index ecf9ed6..6f221d3 100644 --- a/classes/chillerlan-OAuth-Providers-Amazon.html +++ b/classes/chillerlan-OAuth-Providers-Amazon.html @@ -477,6 +477,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -627,6 +633,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -719,6 +732,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1069,9 +1089,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1261,9 +1281,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1311,9 +1331,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1678,9 +1698,9 @@

    @@ -1752,9 +1772,9 @@

    @@ -1829,9 +1849,9 @@

    @@ -1908,9 +1928,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2151,9 +2171,9 @@

    @@ -2218,9 +2238,9 @@

    @@ -2346,9 +2366,9 @@

    @@ -2416,9 +2436,9 @@

    @@ -2584,6 +2604,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2976,9 +3073,9 @@

    @@ -3053,9 +3150,9 @@

    @@ -3259,9 +3356,9 @@

    @@ -3835,9 +3932,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3897,9 +3994,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3966,9 +4063,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4013,6 +4110,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4190,9 +4356,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4426,9 +4592,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4632,9 +4798,9 @@

    Parses the response from a request to the token endpoint

    @@ -4732,9 +4898,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4817,9 +4983,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4920,6 +5086,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5158,6 +5393,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5180,6 +5416,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5193,6 +5430,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-AzureActiveDirectory.html b/classes/chillerlan-OAuth-Providers-AzureActiveDirectory.html index 536389d..8d67956 100644 --- a/classes/chillerlan-OAuth-Providers-AzureActiveDirectory.html +++ b/classes/chillerlan-OAuth-Providers-AzureActiveDirectory.html @@ -480,6 +480,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -623,6 +629,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -715,6 +728,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1041,9 +1061,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1233,9 +1253,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1283,9 +1303,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1648,9 +1668,9 @@

    @@ -1722,9 +1742,9 @@

    @@ -1799,9 +1819,9 @@

    @@ -1878,9 +1898,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2121,9 +2141,9 @@

    @@ -2188,9 +2208,9 @@

    @@ -2316,9 +2336,9 @@

    @@ -2386,9 +2406,9 @@

    @@ -2554,6 +2574,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2889,9 +2986,9 @@

    @@ -2966,9 +3063,9 @@

    @@ -3172,9 +3269,9 @@

    @@ -3748,9 +3845,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3810,9 +3907,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3879,9 +3976,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3926,6 +4023,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4103,9 +4269,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4339,9 +4505,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4545,9 +4711,9 @@

    Parses the response from a request to the token endpoint

    @@ -4645,9 +4811,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4730,9 +4896,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4833,6 +4999,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5070,6 +5305,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • refreshAccessToken()
  • request()
    • @@ -5091,6 +5327,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5104,6 +5341,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-BattleNet.html b/classes/chillerlan-OAuth-Providers-BattleNet.html index bdf4adc..3d1971c 100644 --- a/classes/chillerlan-OAuth-Providers-BattleNet.html +++ b/classes/chillerlan-OAuth-Providers-BattleNet.html @@ -493,6 +493,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -650,6 +656,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -740,6 +753,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1179,9 +1199,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1371,9 +1391,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1421,9 +1441,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1819,9 +1839,9 @@

    @@ -1893,9 +1913,9 @@

    @@ -1970,9 +1990,9 @@

    @@ -2049,9 +2069,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2292,9 +2312,9 @@

    @@ -2359,9 +2379,9 @@

    @@ -2487,9 +2507,9 @@

    @@ -2557,9 +2577,9 @@

    @@ -2725,6 +2745,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3117,9 +3214,9 @@

    @@ -3194,9 +3291,9 @@

    @@ -3461,9 +3558,9 @@

    @@ -4037,9 +4134,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4099,9 +4196,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4168,9 +4265,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4215,6 +4312,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4392,9 +4558,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4614,9 +4780,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4820,9 +4986,9 @@

    Parses the response from a request to the token endpoint

    @@ -4920,9 +5086,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5005,9 +5171,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5108,6 +5274,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5350,6 +5585,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5373,6 +5609,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5386,6 +5623,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-BigCartel.html b/classes/chillerlan-OAuth-Providers-BigCartel.html index 8990132..411b8ce 100644 --- a/classes/chillerlan-OAuth-Providers-BigCartel.html +++ b/classes/chillerlan-OAuth-Providers-BigCartel.html @@ -198,7 +198,7 @@

    -
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -458,17 +458,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -621,6 +620,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -713,6 +719,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -979,9 +992,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1171,9 +1184,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1221,9 +1234,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1569,9 +1582,9 @@

    @@ -1643,9 +1656,9 @@

    @@ -1720,9 +1733,9 @@

    @@ -1799,9 +1812,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2042,9 +2055,9 @@

    @@ -2109,9 +2122,9 @@

    @@ -2237,9 +2250,9 @@

    @@ -2307,9 +2320,9 @@

    @@ -2482,23 +2495,22 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ][, string|null $type = null ]) : bool
    @@ -2511,39 +2523,29 @@
    Parameters
    = null
    +
    +
    + $type + : string|null + = null
    +
    +

    Tags - +
    - implements -
    -
    - -

    \chillerlan\OAuth\Core\TokenInvalidate

    -
    - -
    -
    - codeCoverageIgnore + inheritDoc
    -
    -
    - throws -
    -
    - ProviderException - -
    @@ -2559,23 +2561,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -2594,16 +2596,33 @@
    Parameters
    Tags - +
    - inheritDoc + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore
    +
    +
    + throws +
    +
    + ProviderException + +
    @@ -2684,9 +2703,9 @@

    @@ -2927,9 +2946,9 @@

    @@ -3004,9 +3023,9 @@

    @@ -3210,9 +3229,9 @@

    @@ -3786,9 +3805,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3909,9 +3928,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3978,9 +3997,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4025,6 +4044,75 @@

    Return values
    array<string|int, mixed>
    +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4202,9 +4290,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4438,9 +4526,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4644,9 +4732,9 @@

    Parses the response from a request to the token endpoint

    @@ -4744,9 +4832,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4829,9 +4917,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4932,6 +5020,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5167,8 +5324,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • -
  • InvalidateAccessToken()
  • invalidateAccessToken()
    • +
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5191,6 +5348,7 @@
    Return values
  • getAccountID()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5204,6 +5362,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Bitbucket.html b/classes/chillerlan-OAuth-Providers-Bitbucket.html index 8f5a418..c9de1ba 100644 --- a/classes/chillerlan-OAuth-Providers-Bitbucket.html +++ b/classes/chillerlan-OAuth-Providers-Bitbucket.html @@ -446,6 +446,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -596,6 +602,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -688,6 +701,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -926,9 +946,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1118,9 +1138,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1168,9 +1188,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1535,9 +1555,9 @@

    @@ -1609,9 +1629,9 @@

    @@ -1686,9 +1706,9 @@

    @@ -1765,9 +1785,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2008,9 +2028,9 @@

    @@ -2075,9 +2095,9 @@

    @@ -2203,9 +2223,9 @@

    @@ -2273,9 +2293,9 @@

    @@ -2441,6 +2461,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2833,9 +2930,9 @@

    @@ -2910,9 +3007,9 @@

    @@ -3116,9 +3213,9 @@

    @@ -3692,9 +3789,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3754,9 +3851,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3823,9 +3920,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3870,6 +3967,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4047,9 +4213,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4283,9 +4449,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4489,9 +4655,9 @@

    Parses the response from a request to the token endpoint

    @@ -4589,9 +4755,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4674,9 +4840,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4777,6 +4943,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5011,6 +5246,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5033,6 +5269,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5046,6 +5283,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Codeberg.html b/classes/chillerlan-OAuth-Providers-Codeberg.html index 70bcce0..fac0636 100644 --- a/classes/chillerlan-OAuth-Providers-Codeberg.html +++ b/classes/chillerlan-OAuth-Providers-Codeberg.html @@ -627,6 +627,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -777,6 +783,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -869,6 +882,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1891,9 +1911,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -2083,9 +2103,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -2133,9 +2153,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2498,9 +2518,9 @@

    @@ -2572,9 +2592,9 @@

    @@ -2649,9 +2669,9 @@

    @@ -2728,9 +2748,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2971,9 +2991,9 @@

    @@ -3038,9 +3058,9 @@

    @@ -3166,9 +3186,9 @@

    @@ -3236,9 +3256,9 @@

    @@ -3404,6 +3424,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3796,9 +3893,9 @@

    @@ -3873,9 +3970,9 @@

    @@ -4079,9 +4176,9 @@

    @@ -4655,9 +4752,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4717,9 +4814,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4786,9 +4883,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4833,6 +4930,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -5010,9 +5176,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -5246,9 +5412,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5452,9 +5618,9 @@

    Parses the response from a request to the token endpoint

    @@ -5552,9 +5718,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5637,9 +5803,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5740,6 +5906,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -6002,6 +6237,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -6024,6 +6260,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -6037,6 +6274,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Deezer.html b/classes/chillerlan-OAuth-Providers-Deezer.html index ef12b6b..93c8b02 100644 --- a/classes/chillerlan-OAuth-Providers-Deezer.html +++ b/classes/chillerlan-OAuth-Providers-Deezer.html @@ -499,6 +499,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -649,6 +655,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -741,6 +754,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1231,9 +1251,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1423,9 +1443,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1473,9 +1493,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1838,9 +1858,9 @@

    @@ -1912,9 +1932,9 @@

    @@ -1989,9 +2009,9 @@

    @@ -2068,9 +2088,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2311,9 +2331,9 @@

    @@ -2378,9 +2398,9 @@

    @@ -2506,9 +2526,9 @@

    @@ -2576,9 +2596,9 @@

    @@ -2744,6 +2764,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4348,9 +4514,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4775,9 +4941,9 @@

    Parses the response from a request to the token endpoint

    @@ -4875,9 +5041,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4960,9 +5126,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5063,6 +5229,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5306,6 +5541,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5328,6 +5564,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5341,6 +5578,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-DeviantArt.html b/classes/chillerlan-OAuth-Providers-DeviantArt.html index 11c1f69..e5d9d40 100644 --- a/classes/chillerlan-OAuth-Providers-DeviantArt.html +++ b/classes/chillerlan-OAuth-Providers-DeviantArt.html @@ -191,7 +191,7 @@

    -
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -523,17 +523,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -679,6 +678,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -771,6 +777,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1373,9 +1386,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1565,9 +1578,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1615,9 +1628,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1963,9 +1976,9 @@

    @@ -2037,9 +2050,9 @@

    @@ -2114,9 +2127,9 @@

    @@ -2193,9 +2206,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2436,9 +2449,9 @@

    @@ -2503,9 +2516,9 @@

    @@ -2631,9 +2644,9 @@

    @@ -2701,9 +2714,9 @@

    @@ -2876,23 +2889,22 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ][, string|null $type = null ]) : bool
    @@ -2905,39 +2917,29 @@
    Parameters
    = null
    +
    +
    + $type + : string|null + = null
    +
    +

    Tags - +
    - implements -
    -
    - -

    \chillerlan\OAuth\Core\TokenInvalidate

    -
    - -
    -
    - codeCoverageIgnore + inheritDoc
    -
    -
    - throws -
    -
    - ProviderException - -
    @@ -2953,23 +2955,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -2988,16 +2990,33 @@
    Parameters
    Tags - +
    - inheritDoc + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore
    +
    +
    + throws +
    +
    + ProviderException + +
    @@ -3078,9 +3097,9 @@

    @@ -3321,9 +3340,9 @@

    @@ -3398,9 +3417,9 @@

    @@ -3604,9 +3623,9 @@

    @@ -4180,9 +4199,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4242,9 +4261,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4311,9 +4330,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4358,6 +4377,75 @@

    Return values
    array<string|int, mixed>
    +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4535,9 +4623,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4771,9 +4859,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4977,9 +5065,9 @@

    Parses the response from a request to the token endpoint

    @@ -5077,9 +5165,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5162,9 +5250,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5265,6 +5353,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5512,8 +5669,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • -
  • InvalidateAccessToken()
  • invalidateAccessToken()
    • +
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5535,6 +5692,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5548,6 +5706,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Discord.html b/classes/chillerlan-OAuth-Providers-Discord.html index 184c722..897417b 100644 --- a/classes/chillerlan-OAuth-Providers-Discord.html +++ b/classes/chillerlan-OAuth-Providers-Discord.html @@ -191,7 +191,7 @@

    -
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -566,17 +566,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -722,6 +721,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -814,6 +820,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1612,9 +1625,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1804,9 +1817,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1854,9 +1867,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2204,9 +2217,9 @@

    @@ -2278,9 +2291,9 @@

    @@ -2355,9 +2368,9 @@

    @@ -2434,9 +2447,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2677,9 +2690,9 @@

    @@ -2744,9 +2757,9 @@

    @@ -2872,9 +2885,9 @@

    @@ -2942,9 +2955,9 @@

    @@ -3117,23 +3130,23 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -3142,7 +3155,14 @@
    Parameters
    $token - : AccessToken|null + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null = null
    @@ -3152,7 +3172,7 @@
    Parameters
    Tags - +
    @@ -3161,16 +3181,9 @@
    -

    \chillerlan\OAuth\Core\TokenInvalidate

    +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    -
    -
    - codeCoverageIgnore -
    -
    - -
    throws @@ -3194,23 +3207,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -3219,7 +3232,7 @@
    Parameters
    $token - : AccessToken + : AccessToken|null = null
    @@ -3229,15 +3242,32 @@
    Parameters
    Tags - +
    - inheritDoc + implements
    +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + throws +
    +
    + ProviderException +
    @@ -3262,7 +3292,7 @@

    @@ -3319,9 +3349,9 @@

    @@ -3562,9 +3592,9 @@

    @@ -3639,9 +3669,9 @@

    @@ -3845,9 +3875,9 @@

    @@ -4421,9 +4451,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4483,9 +4513,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4552,9 +4582,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4599,6 +4629,80 @@

    Return values
    array<string|int, mixed>

    +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + + +
    +
    + link +
    +
    + https://github.com/discord/discord-api-docs/issues/2259#issuecomment-927180184 + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4776,9 +4880,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -5012,9 +5116,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5218,9 +5322,9 @@

    Parses the response from a request to the token endpoint

    @@ -5318,9 +5422,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5403,9 +5507,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5506,6 +5610,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5760,8 +5933,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
    • -
  • invalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5783,6 +5956,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5796,6 +5970,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Foursquare.html b/classes/chillerlan-OAuth-Providers-Foursquare.html index c6b2a99..0a9d428 100644 --- a/classes/chillerlan-OAuth-Providers-Foursquare.html +++ b/classes/chillerlan-OAuth-Providers-Foursquare.html @@ -469,6 +469,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -617,6 +623,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -709,6 +722,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1059,9 +1079,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1251,9 +1271,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1301,9 +1321,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1666,9 +1686,9 @@

    @@ -1740,9 +1760,9 @@

    @@ -1817,9 +1837,9 @@

    @@ -1896,9 +1916,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2139,9 +2159,9 @@

    @@ -2206,9 +2226,9 @@

    @@ -2334,9 +2354,9 @@

    @@ -2404,9 +2424,9 @@

    @@ -2572,6 +2592,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2960,9 +3057,9 @@

    @@ -3037,9 +3134,9 @@

    @@ -3243,9 +3340,9 @@

    @@ -3819,9 +3916,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3881,9 +3978,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3950,9 +4047,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3997,6 +4094,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4174,9 +4340,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4410,9 +4576,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4616,9 +4782,9 @@

    Parses the response from a request to the token endpoint

    @@ -4716,9 +4882,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4801,9 +4967,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4904,6 +5070,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5142,6 +5377,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5164,6 +5400,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5177,6 +5414,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-GitHub.html b/classes/chillerlan-OAuth-Providers-GitHub.html index 1de4efc..1b212cf 100644 --- a/classes/chillerlan-OAuth-Providers-GitHub.html +++ b/classes/chillerlan-OAuth-Providers-GitHub.html @@ -627,6 +627,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -777,6 +783,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -869,6 +882,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1891,9 +1911,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -2083,9 +2103,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -2133,9 +2153,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2498,9 +2518,9 @@

    @@ -2572,9 +2592,9 @@

    @@ -2649,9 +2669,9 @@

    @@ -2728,9 +2748,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2971,9 +2991,9 @@

    @@ -3038,9 +3058,9 @@

    @@ -3166,9 +3186,9 @@

    @@ -3236,9 +3256,9 @@

    @@ -3404,6 +3424,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3796,9 +3893,9 @@

    @@ -3873,9 +3970,9 @@

    @@ -4079,9 +4176,9 @@

    @@ -4655,9 +4752,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4717,9 +4814,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4786,9 +4883,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4833,6 +4930,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -5010,9 +5176,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -5246,9 +5412,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5452,9 +5618,9 @@

    Parses the response from a request to the token endpoint

    @@ -5552,9 +5718,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5637,9 +5803,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5740,6 +5906,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -6002,6 +6237,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -6024,6 +6260,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -6037,6 +6274,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-GitLab.html b/classes/chillerlan-OAuth-Providers-GitLab.html index e059d55..b010b42 100644 --- a/classes/chillerlan-OAuth-Providers-GitLab.html +++ b/classes/chillerlan-OAuth-Providers-GitLab.html @@ -446,6 +446,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -596,6 +602,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -688,6 +701,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -926,9 +946,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1118,9 +1138,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1168,9 +1188,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1535,9 +1555,9 @@

    @@ -1609,9 +1629,9 @@

    @@ -1686,9 +1706,9 @@

    @@ -1765,9 +1785,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2008,9 +2028,9 @@

    @@ -2075,9 +2095,9 @@

    @@ -2203,9 +2223,9 @@

    @@ -2273,9 +2293,9 @@

    @@ -2441,6 +2461,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2833,9 +2930,9 @@

    @@ -2910,9 +3007,9 @@

    @@ -3116,9 +3213,9 @@

    @@ -3692,9 +3789,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3754,9 +3851,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3823,9 +3920,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3870,6 +3967,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4047,9 +4213,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4283,9 +4449,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4489,9 +4655,9 @@

    Parses the response from a request to the token endpoint

    @@ -4589,9 +4755,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4674,9 +4840,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4777,6 +4943,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5011,6 +5246,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5033,6 +5269,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5046,6 +5283,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Gitea.html b/classes/chillerlan-OAuth-Providers-Gitea.html index 3f58be4..2274b5f 100644 --- a/classes/chillerlan-OAuth-Providers-Gitea.html +++ b/classes/chillerlan-OAuth-Providers-Gitea.html @@ -595,6 +595,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -745,6 +751,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -837,6 +850,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1775,9 +1795,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1967,9 +1987,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -2017,9 +2037,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2382,9 +2402,9 @@

    @@ -2456,9 +2476,9 @@

    @@ -2533,9 +2553,9 @@

    @@ -2612,9 +2632,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2855,9 +2875,9 @@

    @@ -2922,9 +2942,9 @@

    @@ -3050,9 +3070,9 @@

    @@ -3120,9 +3140,9 @@

    @@ -3288,6 +3308,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3680,9 +3777,9 @@

    @@ -3757,9 +3854,9 @@

    @@ -3963,9 +4060,9 @@

    @@ -4539,9 +4636,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4601,9 +4698,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4670,9 +4767,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4717,6 +4814,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4894,9 +5060,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -5130,9 +5296,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5336,9 +5502,9 @@

    Parses the response from a request to the token endpoint

    @@ -5436,9 +5602,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5521,9 +5687,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5624,6 +5790,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5883,6 +6118,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5905,6 +6141,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5918,6 +6155,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Google.html b/classes/chillerlan-OAuth-Providers-Google.html index e714ca7..a70cf2a 100644 --- a/classes/chillerlan-OAuth-Providers-Google.html +++ b/classes/chillerlan-OAuth-Providers-Google.html @@ -489,6 +489,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -639,6 +645,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -731,6 +744,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1109,9 +1129,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1301,9 +1321,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1351,9 +1371,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1716,9 +1736,9 @@

    @@ -1790,9 +1810,9 @@

    @@ -1867,9 +1887,9 @@

    @@ -1946,9 +1966,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2189,9 +2209,9 @@

    @@ -2256,9 +2276,9 @@

    @@ -2384,9 +2404,9 @@

    @@ -2454,9 +2474,9 @@

    @@ -2622,6 +2642,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3014,9 +3111,9 @@

    @@ -3091,9 +3188,9 @@

    @@ -3297,9 +3394,9 @@

    @@ -3873,9 +3970,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3935,9 +4032,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4004,9 +4101,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4051,6 +4148,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4228,9 +4394,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4464,9 +4630,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4670,9 +4836,9 @@

    Parses the response from a request to the token endpoint

    @@ -4770,9 +4936,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4855,9 +5021,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4958,6 +5124,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5197,6 +5432,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5219,6 +5455,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5232,6 +5469,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-GuildWars2.html b/classes/chillerlan-OAuth-Providers-GuildWars2.html index 58e1ad5..436e4c1 100644 --- a/classes/chillerlan-OAuth-Providers-GuildWars2.html +++ b/classes/chillerlan-OAuth-Providers-GuildWars2.html @@ -515,6 +515,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -671,6 +677,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -763,6 +776,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1283,9 +1303,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1475,9 +1495,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1525,9 +1545,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1890,9 +1910,9 @@

    @@ -1964,9 +1984,9 @@

    @@ -2041,9 +2061,9 @@

    @@ -2444,9 +2464,9 @@

    @@ -2572,9 +2592,9 @@

    @@ -2642,9 +2662,9 @@

    @@ -2810,6 +2830,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3202,9 +3299,9 @@

    @@ -3279,9 +3376,9 @@

    @@ -3485,9 +3582,9 @@

    @@ -4121,9 +4218,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4183,9 +4280,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4252,9 +4349,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4299,6 +4396,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4476,9 +4642,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4712,9 +4878,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4918,9 +5084,9 @@

    Parses the response from a request to the token endpoint

    @@ -5018,9 +5184,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5103,9 +5269,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5206,6 +5372,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5450,6 +5685,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5473,6 +5709,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5486,6 +5723,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Imgur.html b/classes/chillerlan-OAuth-Providers-Imgur.html index 4f16d04..0109f56 100644 --- a/classes/chillerlan-OAuth-Providers-Imgur.html +++ b/classes/chillerlan-OAuth-Providers-Imgur.html @@ -448,6 +448,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -598,6 +604,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -690,6 +703,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -928,9 +948,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1120,9 +1140,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1170,9 +1190,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1535,9 +1555,9 @@

    @@ -1609,9 +1629,9 @@

    @@ -1686,9 +1706,9 @@

    @@ -2007,9 +2027,9 @@

    @@ -2074,9 +2094,9 @@

    @@ -2202,9 +2222,9 @@

    @@ -2272,9 +2292,9 @@

    @@ -2440,6 +2460,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2832,9 +2929,9 @@

    @@ -2909,9 +3006,9 @@

    @@ -3115,9 +3212,9 @@

    @@ -3691,9 +3788,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3753,9 +3850,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3822,9 +3919,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3869,6 +3966,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4046,9 +4212,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4282,9 +4448,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4488,9 +4654,9 @@

    Parses the response from a request to the token endpoint

    @@ -4588,9 +4754,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4673,9 +4839,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4776,6 +4942,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5010,6 +5245,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5032,6 +5268,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5045,6 +5282,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-MailChimp.html b/classes/chillerlan-OAuth-Providers-MailChimp.html index 0e6d7f7..33490e2 100644 --- a/classes/chillerlan-OAuth-Providers-MailChimp.html +++ b/classes/chillerlan-OAuth-Providers-MailChimp.html @@ -471,6 +471,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -619,6 +625,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -710,6 +723,13 @@

     : ResponseInterface

    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1004,9 +1024,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1196,9 +1216,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1246,9 +1266,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1613,9 +1633,9 @@

    @@ -1687,9 +1707,9 @@

    @@ -1764,9 +1784,9 @@

    @@ -2085,9 +2105,9 @@

    @@ -2152,9 +2172,9 @@

    @@ -2280,9 +2300,9 @@

    @@ -2350,9 +2370,9 @@

    @@ -2578,6 +2598,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2966,9 +3063,9 @@

    @@ -3043,9 +3140,9 @@

    @@ -3249,9 +3346,9 @@

    @@ -3825,9 +3922,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3887,9 +3984,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3956,9 +4053,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4003,6 +4100,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4180,9 +4346,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4416,9 +4582,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4622,9 +4788,9 @@

    Parses the response from a request to the token endpoint

    @@ -4722,9 +4888,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4807,9 +4973,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4919,6 +5085,75 @@

    +
    + + +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + +
    @@ -5159,6 +5394,7 @@
    Return values
  • getStorage()
  • getTokenMetadata()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5181,6 +5417,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5194,6 +5431,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Mastodon.html b/classes/chillerlan-OAuth-Providers-Mastodon.html index 7dfa300..3e8ae26 100644 --- a/classes/chillerlan-OAuth-Providers-Mastodon.html +++ b/classes/chillerlan-OAuth-Providers-Mastodon.html @@ -488,6 +488,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -645,6 +651,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -737,6 +750,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1115,9 +1135,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1340,9 +1360,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1390,9 +1410,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1755,9 +1775,9 @@

    @@ -1829,9 +1849,9 @@

    @@ -1906,9 +1926,9 @@

    @@ -2227,9 +2247,9 @@

    @@ -2294,9 +2314,9 @@

    @@ -2422,9 +2442,9 @@

    @@ -2492,9 +2512,9 @@

    @@ -2660,6 +2680,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3052,9 +3149,9 @@

    @@ -3129,9 +3226,9 @@

    @@ -3396,9 +3493,9 @@

    @@ -3972,9 +4069,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4034,9 +4131,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4103,9 +4200,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4150,6 +4247,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4327,9 +4493,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4563,9 +4729,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4769,9 +4935,9 @@

    Parses the response from a request to the token endpoint

    @@ -4869,9 +5035,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4954,9 +5120,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5057,6 +5223,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5297,6 +5532,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5320,6 +5556,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5333,6 +5570,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-MicrosoftGraph.html b/classes/chillerlan-OAuth-Providers-MicrosoftGraph.html index 3d9beaf..6511105 100644 --- a/classes/chillerlan-OAuth-Providers-MicrosoftGraph.html +++ b/classes/chillerlan-OAuth-Providers-MicrosoftGraph.html @@ -491,6 +491,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -641,6 +647,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -733,6 +746,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1173,9 +1193,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1365,9 +1385,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1415,9 +1435,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1782,9 +1802,9 @@

    @@ -1856,9 +1876,9 @@

    @@ -1933,9 +1953,9 @@

    @@ -2012,9 +2032,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2255,9 +2275,9 @@

    @@ -2322,9 +2342,9 @@

    @@ -2450,9 +2470,9 @@

    @@ -2520,9 +2540,9 @@

    @@ -2688,6 +2708,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3080,9 +3177,9 @@

    @@ -3157,9 +3254,9 @@

    @@ -3363,9 +3460,9 @@

    @@ -3939,9 +4036,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4001,9 +4098,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4070,9 +4167,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4117,6 +4214,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4294,9 +4460,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4530,9 +4696,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4736,9 +4902,9 @@

    Parses the response from a request to the token endpoint

    @@ -4836,9 +5002,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4921,9 +5087,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5024,6 +5190,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5265,6 +5500,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5287,6 +5523,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5300,6 +5537,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Mixcloud.html b/classes/chillerlan-OAuth-Providers-Mixcloud.html index 23185c8..c447403 100644 --- a/classes/chillerlan-OAuth-Providers-Mixcloud.html +++ b/classes/chillerlan-OAuth-Providers-Mixcloud.html @@ -453,6 +453,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -603,6 +609,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -695,6 +708,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -961,9 +981,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1153,9 +1173,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1203,9 +1223,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1568,9 +1588,9 @@

    @@ -1642,9 +1662,9 @@

    @@ -1719,9 +1739,9 @@

    @@ -1798,9 +1818,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2041,9 +2061,9 @@

    @@ -2108,9 +2128,9 @@

    @@ -2236,9 +2256,9 @@

    @@ -2306,9 +2326,9 @@

    @@ -2474,6 +2494,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2866,9 +2963,9 @@

    @@ -2943,9 +3040,9 @@

    @@ -3149,9 +3246,9 @@

    @@ -3725,9 +3822,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3787,9 +3884,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3856,9 +3953,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3903,6 +4000,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4080,9 +4246,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4316,9 +4482,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4522,9 +4688,9 @@

    Parses the response from a request to the token endpoint

    @@ -4622,9 +4788,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4707,9 +4873,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4810,6 +4976,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5045,6 +5280,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5067,6 +5303,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5080,6 +5317,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-MusicBrainz.html b/classes/chillerlan-OAuth-Providers-MusicBrainz.html index 0c34a80..ba44fdc 100644 --- a/classes/chillerlan-OAuth-Providers-MusicBrainz.html +++ b/classes/chillerlan-OAuth-Providers-MusicBrainz.html @@ -198,7 +198,7 @@

    -
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -500,17 +500,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -654,6 +653,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -746,6 +752,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1208,9 +1221,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1400,9 +1413,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1450,9 +1463,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1798,9 +1811,9 @@

    @@ -1872,9 +1885,9 @@

    @@ -1949,9 +1962,9 @@

    @@ -2028,9 +2041,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2271,9 +2284,9 @@

    @@ -2338,9 +2351,9 @@

    @@ -2466,9 +2479,9 @@

    @@ -2536,9 +2549,9 @@

    @@ -2711,23 +2724,23 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -2736,7 +2749,14 @@
    Parameters
    $token - : AccessToken|null + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null = null
    @@ -2746,7 +2766,7 @@
    Parameters
    Tags - +
    @@ -2755,16 +2775,9 @@
    -

    \chillerlan\OAuth\Core\TokenInvalidate

    +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    -
    -
    - codeCoverageIgnore -
    -
    - -
    throws @@ -2788,23 +2801,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -2823,16 +2836,33 @@
    Parameters
    Tags - +
    - inheritDoc + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore
    +
    +
    + throws +
    +
    + ProviderException + +
    @@ -2856,7 +2886,7 @@

    @@ -2913,9 +2943,9 @@

    @@ -2983,7 +3013,7 @@

    @@ -3145,9 +3175,9 @@

    @@ -3222,9 +3252,9 @@

    @@ -3428,9 +3458,9 @@

    @@ -4004,9 +4034,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4066,9 +4096,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4135,9 +4165,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4174,6 +4204,73 @@

    OAuth2Provider::getClientCredentialsToken() + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +

    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + +
    @@ -4290,9 +4387,9 @@

    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4593,9 +4690,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4799,9 +4896,9 @@

    Parses the response from a request to the token endpoint

    @@ -4899,9 +4996,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4984,9 +5081,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5087,6 +5184,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5329,8 +5495,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
    • -
  • invalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5352,6 +5518,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5365,6 +5532,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-NPROne.html b/classes/chillerlan-OAuth-Providers-NPROne.html index 22aae9a..6a14a7f 100644 --- a/classes/chillerlan-OAuth-Providers-NPROne.html +++ b/classes/chillerlan-OAuth-Providers-NPROne.html @@ -198,7 +198,7 @@

    -
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -489,17 +489,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -652,6 +651,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -744,6 +750,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1150,9 +1163,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1342,9 +1355,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1392,9 +1405,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1742,9 +1755,9 @@

    @@ -1816,9 +1829,9 @@

    @@ -1893,9 +1906,9 @@

    @@ -1972,9 +1985,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2215,9 +2228,9 @@

    @@ -2282,9 +2295,9 @@

    @@ -2410,9 +2423,9 @@

    @@ -2480,9 +2493,9 @@

    @@ -2655,23 +2668,23 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -2680,7 +2693,14 @@
    Parameters
    $token - : AccessToken|null + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null = null
    @@ -2690,7 +2710,7 @@
    Parameters
    Tags - +
    @@ -2699,16 +2719,9 @@
    -

    \chillerlan\OAuth\Core\TokenInvalidate

    +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    -
    -
    - codeCoverageIgnore -
    -
    - -
    throws @@ -2732,23 +2745,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -2767,16 +2780,33 @@
    Parameters
    Tags - +
    - inheritDoc + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore
    +
    +
    + throws +
    +
    + ProviderException + +
    @@ -2857,9 +2887,9 @@

    @@ -3161,9 +3191,9 @@

    @@ -3238,9 +3268,9 @@

    @@ -3444,9 +3474,9 @@

    @@ -4020,9 +4050,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4082,9 +4112,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4151,9 +4181,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4198,6 +4228,75 @@

    Return values
    array<string|int, mixed>

    +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4375,9 +4474,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4611,9 +4710,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4817,9 +4916,9 @@

    Parses the response from a request to the token endpoint

    @@ -4917,9 +5016,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5002,9 +5101,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5105,6 +5204,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5345,8 +5513,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
    • -
  • invalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5369,6 +5537,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5382,6 +5551,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-OpenStreetmap2.html b/classes/chillerlan-OAuth-Providers-OpenStreetmap2.html index 5a40459..d44dea4 100644 --- a/classes/chillerlan-OAuth-Providers-OpenStreetmap2.html +++ b/classes/chillerlan-OAuth-Providers-OpenStreetmap2.html @@ -520,6 +520,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -670,6 +676,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -762,6 +775,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1280,9 +1300,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1472,9 +1492,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1522,9 +1542,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1889,9 +1909,9 @@

    @@ -1963,9 +1983,9 @@

    @@ -2040,9 +2060,9 @@

    @@ -2119,9 +2139,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2362,9 +2382,9 @@

    @@ -2429,9 +2449,9 @@

    @@ -2557,9 +2577,9 @@

    @@ -2627,9 +2647,9 @@

    @@ -2795,6 +2815,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3187,9 +3284,9 @@

    @@ -3264,9 +3361,9 @@

    @@ -3470,9 +3567,9 @@

    @@ -4046,9 +4143,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4108,9 +4205,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4177,9 +4274,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4224,6 +4321,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4401,9 +4567,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4637,9 +4803,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4843,9 +5009,9 @@

    Parses the response from a request to the token endpoint

    @@ -4943,9 +5109,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5028,9 +5194,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5131,6 +5297,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5375,6 +5610,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5397,6 +5633,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5410,6 +5647,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Patreon.html b/classes/chillerlan-OAuth-Providers-Patreon.html index f9a4d5b..f4e64bf 100644 --- a/classes/chillerlan-OAuth-Providers-Patreon.html +++ b/classes/chillerlan-OAuth-Providers-Patreon.html @@ -532,6 +532,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -682,6 +688,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -774,6 +787,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1348,9 +1368,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1540,9 +1560,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1590,9 +1610,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1957,9 +1977,9 @@

    @@ -2031,9 +2051,9 @@

    @@ -2108,9 +2128,9 @@

    @@ -2187,9 +2207,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2430,9 +2450,9 @@

    @@ -2497,9 +2517,9 @@

    @@ -2625,9 +2645,9 @@

    @@ -2695,9 +2715,9 @@

    @@ -2863,6 +2883,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3248,9 +3345,9 @@

    @@ -3325,9 +3422,9 @@

    @@ -3531,9 +3628,9 @@

    @@ -4107,9 +4204,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4169,9 +4266,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4238,9 +4335,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4285,6 +4382,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4462,9 +4628,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4698,9 +4864,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4904,9 +5070,9 @@

    Parses the response from a request to the token endpoint

    @@ -5004,9 +5170,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5089,9 +5255,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5192,6 +5358,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5438,6 +5673,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5460,6 +5696,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5473,6 +5710,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-PayPal.html b/classes/chillerlan-OAuth-Providers-PayPal.html index f06ea15..f5d8a09 100644 --- a/classes/chillerlan-OAuth-Providers-PayPal.html +++ b/classes/chillerlan-OAuth-Providers-PayPal.html @@ -488,6 +488,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -638,6 +644,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -730,6 +743,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1164,9 +1184,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1356,9 +1376,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1406,9 +1426,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1773,9 +1793,9 @@

    @@ -1847,9 +1867,9 @@

    @@ -1924,9 +1944,9 @@

    @@ -2003,9 +2023,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2246,9 +2266,9 @@

    @@ -2313,9 +2333,9 @@

    @@ -2441,9 +2461,9 @@

    @@ -2511,9 +2531,9 @@

    @@ -2679,6 +2699,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3071,9 +3168,9 @@

    @@ -3148,9 +3245,9 @@

    @@ -3354,9 +3451,9 @@

    @@ -3930,9 +4027,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3992,9 +4089,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4061,9 +4158,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4108,6 +4205,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4285,9 +4451,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4521,9 +4687,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4727,9 +4893,9 @@

    Parses the response from a request to the token endpoint

    @@ -4827,9 +4993,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4912,9 +5078,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5015,6 +5181,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5256,6 +5491,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5278,6 +5514,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5291,6 +5528,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-PayPalSandbox.html b/classes/chillerlan-OAuth-Providers-PayPalSandbox.html index 845858e..d0a3e2e 100644 --- a/classes/chillerlan-OAuth-Providers-PayPalSandbox.html +++ b/classes/chillerlan-OAuth-Providers-PayPalSandbox.html @@ -479,6 +479,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -629,6 +635,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -721,6 +734,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1159,9 +1179,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1351,9 +1371,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1401,9 +1421,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1768,9 +1788,9 @@

    @@ -1842,9 +1862,9 @@

    @@ -1919,9 +1939,9 @@

    @@ -1998,9 +2018,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2241,9 +2261,9 @@

    @@ -2308,9 +2328,9 @@

    @@ -2436,9 +2456,9 @@

    @@ -2506,9 +2526,9 @@

    @@ -2674,6 +2694,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3066,9 +3163,9 @@

    @@ -3143,9 +3240,9 @@

    @@ -3349,9 +3446,9 @@

    @@ -3925,9 +4022,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3987,9 +4084,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4056,9 +4153,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4103,6 +4200,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4280,9 +4446,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4516,9 +4682,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4722,9 +4888,9 @@

    Parses the response from a request to the token endpoint

    @@ -4822,9 +4988,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4907,9 +5073,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5010,6 +5176,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5251,6 +5486,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5273,6 +5509,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5286,6 +5523,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Pinterest.html b/classes/chillerlan-OAuth-Providers-Pinterest.html index a1754a2..909b9d8 100644 --- a/classes/chillerlan-OAuth-Providers-Pinterest.html +++ b/classes/chillerlan-OAuth-Providers-Pinterest.html @@ -535,6 +535,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -685,6 +691,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -777,6 +790,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1435,9 +1455,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1627,9 +1647,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1677,9 +1697,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2042,9 +2062,9 @@

    @@ -2116,9 +2136,9 @@

    @@ -2193,9 +2213,9 @@

    @@ -2272,9 +2292,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2515,9 +2535,9 @@

    @@ -2582,9 +2602,9 @@

    @@ -2710,9 +2730,9 @@

    @@ -2780,9 +2800,9 @@

    @@ -2948,6 +2968,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3340,9 +3437,9 @@

    @@ -3417,9 +3514,9 @@

    @@ -3623,9 +3720,9 @@

    @@ -4199,9 +4296,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4261,9 +4358,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4330,9 +4427,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4377,6 +4474,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4554,9 +4720,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4790,9 +4956,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4996,9 +5162,9 @@

    Parses the response from a request to the token endpoint

    @@ -5096,9 +5262,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5181,9 +5347,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5284,6 +5450,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5533,6 +5768,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5555,6 +5791,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5568,6 +5805,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Reddit.html b/classes/chillerlan-OAuth-Providers-Reddit.html index 522c74e..8fa22e6 100644 --- a/classes/chillerlan-OAuth-Providers-Reddit.html +++ b/classes/chillerlan-OAuth-Providers-Reddit.html @@ -152,7 +152,7 @@

    @@ -190,6 +190,13 @@

    link
    +
    + https://github.com/reddit-archive/reddit/wiki/OAuth2#manually-revoking-a-token + +
    +
    + link +
    https://www.reddit.com/dev/api @@ -212,7 +219,7 @@

    -
    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")
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    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")
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -670,17 +677,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -826,6 +832,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -918,6 +931,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -947,7 +967,7 @@

    @@ -975,7 +995,7 @@

    @@ -1003,7 +1023,7 @@

    @@ -1031,7 +1051,7 @@

    @@ -1059,7 +1079,7 @@

    @@ -1087,7 +1107,7 @@

    @@ -1115,7 +1135,7 @@

    @@ -1143,7 +1163,7 @@

    @@ -1171,7 +1191,7 @@

    @@ -1199,7 +1219,7 @@

    @@ -1227,7 +1247,7 @@

    @@ -1255,7 +1275,7 @@

    @@ -1283,7 +1303,7 @@

    @@ -1311,7 +1331,7 @@

    @@ -1339,7 +1359,7 @@

    @@ -1367,7 +1387,7 @@

    @@ -1395,7 +1415,7 @@

    @@ -1423,7 +1443,7 @@

    @@ -1451,7 +1471,7 @@

    @@ -1479,7 +1499,7 @@

    @@ -1507,7 +1527,7 @@

    @@ -1535,7 +1555,7 @@

    @@ -1563,7 +1583,7 @@

    @@ -1591,7 +1611,7 @@

    @@ -1619,7 +1639,7 @@

    @@ -1647,7 +1667,7 @@

    @@ -1675,7 +1695,7 @@

    @@ -1703,7 +1723,7 @@

    @@ -1731,7 +1751,7 @@

    @@ -1759,7 +1779,7 @@

    @@ -1787,7 +1807,7 @@

    @@ -1815,7 +1835,7 @@

    @@ -1843,7 +1863,7 @@

    @@ -1871,7 +1891,7 @@

    @@ -1899,7 +1919,7 @@

    Reddit.php : - 80 + 82 @@ -1943,7 +1963,7 @@

    @@ -1976,7 +1996,7 @@

    @@ -2009,7 +2029,7 @@

    @@ -2042,7 +2062,7 @@

    @@ -2075,7 +2095,7 @@

    @@ -2108,9 +2128,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -2300,9 +2320,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -2350,9 +2370,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2437,7 +2457,7 @@

    @@ -2575,7 +2595,7 @@

    @@ -2698,9 +2718,9 @@

    @@ -2772,9 +2792,9 @@

    @@ -2849,9 +2869,9 @@

    @@ -2928,9 +2948,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -3171,9 +3191,9 @@

    @@ -3238,9 +3258,9 @@

    @@ -3366,9 +3386,9 @@

    @@ -3436,9 +3456,9 @@

    @@ -3611,23 +3631,23 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -3636,7 +3656,14 @@
    Parameters
    $token - : AccessToken|null + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null = null
    @@ -3646,7 +3673,7 @@
    Parameters
    Tags - +
    @@ -3655,16 +3682,9 @@
    -

    \chillerlan\OAuth\Core\TokenInvalidate

    +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    -
    -
    - codeCoverageIgnore -
    -
    - -
    throws @@ -3688,23 +3708,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -3713,7 +3733,7 @@
    Parameters
    $token - : AccessToken + : AccessToken|null = null
    @@ -3723,23 +3743,33 @@
    Parameters
    Tags - +
    - link + implements
    - https://github.com/reddit-archive/reddit/wiki/OAuth2#manually-revoking-a-token - + +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    +
    - inheritDoc + codeCoverageIgnore
    +
    +
    + throws +
    +
    + ProviderException + +
    @@ -3763,7 +3793,7 @@

    @@ -3820,9 +3850,9 @@

    @@ -4063,9 +4093,9 @@

    @@ -4140,9 +4170,9 @@

    @@ -4346,9 +4376,9 @@

    @@ -4922,9 +4952,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4984,9 +5014,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -5053,9 +5083,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -5100,6 +5130,75 @@

    Return values
    array<string|int, mixed>

    +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -5277,9 +5376,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -5513,9 +5612,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5719,9 +5818,9 @@

    Parses the response from a request to the token endpoint

    @@ -5819,9 +5918,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5904,9 +6003,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -6007,6 +6106,73 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + + +
    +
    +
    Return values
    ResponseInterface @@ -6275,8 +6441,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
    • -
  • invalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -6298,6 +6464,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -6311,6 +6478,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Slack.html b/classes/chillerlan-OAuth-Providers-Slack.html index a7b73d6..6ad724f 100644 --- a/classes/chillerlan-OAuth-Providers-Slack.html +++ b/classes/chillerlan-OAuth-Providers-Slack.html @@ -765,6 +765,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -915,6 +921,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -1007,6 +1020,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -2673,9 +2693,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -2865,9 +2885,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -2915,9 +2935,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -3280,9 +3300,9 @@

    @@ -3354,9 +3374,9 @@

    @@ -3431,9 +3451,9 @@

    @@ -3510,9 +3530,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -3753,9 +3773,9 @@

    @@ -3820,9 +3840,9 @@

    @@ -3948,9 +3968,9 @@

    @@ -4018,9 +4038,9 @@

    @@ -4186,6 +4206,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -4578,9 +4675,9 @@

    @@ -4655,9 +4752,9 @@

    @@ -4861,9 +4958,9 @@

    @@ -5437,9 +5534,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -5499,9 +5596,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -5568,9 +5665,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -5615,6 +5712,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -5792,9 +5958,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -6028,9 +6194,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -6234,9 +6400,9 @@

    Parses the response from a request to the token endpoint

    @@ -6334,9 +6500,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -6419,9 +6585,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -6522,6 +6688,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -6807,6 +7042,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -6829,6 +7065,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -6842,6 +7079,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-SoundCloud.html b/classes/chillerlan-OAuth-Providers-SoundCloud.html index 108edda..84ee49d 100644 --- a/classes/chillerlan-OAuth-Providers-SoundCloud.html +++ b/classes/chillerlan-OAuth-Providers-SoundCloud.html @@ -477,6 +477,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -627,6 +633,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -719,6 +732,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1041,9 +1061,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1233,9 +1253,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1283,9 +1303,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1648,9 +1668,9 @@

    @@ -1722,9 +1742,9 @@

    @@ -1799,9 +1819,9 @@

    @@ -1878,9 +1898,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2121,9 +2141,9 @@

    @@ -2188,9 +2208,9 @@

    @@ -2316,9 +2336,9 @@

    @@ -2386,9 +2406,9 @@

    @@ -2554,6 +2574,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2946,9 +3043,9 @@

    @@ -3023,9 +3120,9 @@

    @@ -3229,9 +3326,9 @@

    @@ -3805,9 +3902,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3867,9 +3964,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3936,9 +4033,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3983,6 +4080,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4160,9 +4326,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4396,9 +4562,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4602,9 +4768,9 @@

    Parses the response from a request to the token endpoint

    @@ -4702,9 +4868,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4787,9 +4953,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4890,6 +5056,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5127,6 +5362,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5149,6 +5385,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5162,6 +5399,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Spotify.html b/classes/chillerlan-OAuth-Providers-Spotify.html index 4a339dc..69af23b 100644 --- a/classes/chillerlan-OAuth-Providers-Spotify.html +++ b/classes/chillerlan-OAuth-Providers-Spotify.html @@ -603,6 +603,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -753,6 +759,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -845,6 +858,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1769,9 +1789,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1961,9 +1981,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -2011,9 +2031,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2376,9 +2396,9 @@

    @@ -2450,9 +2470,9 @@

    @@ -2527,9 +2547,9 @@

    @@ -2606,9 +2626,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2849,9 +2869,9 @@

    @@ -2916,9 +2936,9 @@

    @@ -3044,9 +3064,9 @@

    @@ -3114,9 +3134,9 @@

    @@ -3282,6 +3302,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3674,9 +3771,9 @@

    @@ -3751,9 +3848,9 @@

    @@ -3957,9 +4054,9 @@

    @@ -4533,9 +4630,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4595,9 +4692,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4664,9 +4761,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4711,6 +4808,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4888,9 +5054,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -5124,9 +5290,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5330,9 +5496,9 @@

    Parses the response from a request to the token endpoint

    @@ -5430,9 +5596,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5515,9 +5681,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5618,6 +5784,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5876,6 +6111,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5898,6 +6134,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5911,6 +6148,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Stripe.html b/classes/chillerlan-OAuth-Providers-Stripe.html index 02f84c8..25bf277 100644 --- a/classes/chillerlan-OAuth-Providers-Stripe.html +++ b/classes/chillerlan-OAuth-Providers-Stripe.html @@ -219,7 +219,7 @@

    -
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    CSRFToken
    Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -491,17 +491,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -647,6 +646,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -739,6 +745,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1061,9 +1074,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1253,9 +1266,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1303,9 +1316,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1651,9 +1664,9 @@

    @@ -1725,9 +1738,9 @@

    @@ -1802,9 +1815,9 @@

    @@ -1881,9 +1894,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2124,9 +2137,9 @@

    @@ -2191,9 +2204,9 @@

    @@ -2319,9 +2332,9 @@

    @@ -2389,9 +2402,9 @@

    @@ -2564,23 +2577,23 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -2589,7 +2602,14 @@
    Parameters
    $token - : AccessToken|null + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null = null
    @@ -2599,7 +2619,7 @@
    Parameters
    Tags - +
    @@ -2608,16 +2628,9 @@
    -

    \chillerlan\OAuth\Core\TokenInvalidate

    +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    -
    -
    - codeCoverageIgnore -
    -
    - -
    throws @@ -2641,23 +2654,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -2676,16 +2689,33 @@
    Parameters
    Tags - +
    - inheritDoc + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore
    +
    +
    + throws +
    +
    + ProviderException + +
    @@ -2766,9 +2796,9 @@

    @@ -3009,9 +3039,9 @@

    @@ -3086,9 +3116,9 @@

    @@ -3292,9 +3322,9 @@

    @@ -3868,9 +3898,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3930,9 +3960,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3999,9 +4029,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4038,6 +4068,73 @@

    OAuth2Provider::getClientCredentialsToken() + + + +
    +
    Return values
    + array<string|int, mixed> +
    + +

    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + +
    @@ -4154,9 +4251,9 @@

    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4223,9 +4320,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4459,9 +4556,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4665,9 +4762,9 @@

    Parses the response from a request to the token endpoint

    @@ -4765,9 +4862,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4850,9 +4947,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4953,6 +5050,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5190,8 +5356,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
    • -
  • invalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5213,6 +5379,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5226,6 +5393,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Tumblr2.html b/classes/chillerlan-OAuth-Providers-Tumblr2.html index 31de9da..dd8c780 100644 --- a/classes/chillerlan-OAuth-Providers-Tumblr2.html +++ b/classes/chillerlan-OAuth-Providers-Tumblr2.html @@ -469,6 +469,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -619,6 +625,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -711,6 +724,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1061,9 +1081,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1253,9 +1273,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1303,9 +1323,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1668,9 +1688,9 @@

    @@ -1742,9 +1762,9 @@

    @@ -1819,9 +1839,9 @@

    @@ -1898,9 +1918,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2141,9 +2161,9 @@

    @@ -2208,9 +2228,9 @@

    @@ -2336,9 +2356,9 @@

    @@ -2406,9 +2426,9 @@

    @@ -2574,6 +2594,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2966,9 +3063,9 @@

    @@ -3043,9 +3140,9 @@

    @@ -3249,9 +3346,9 @@

    @@ -3825,9 +3922,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3887,9 +3984,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3956,9 +4053,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4003,6 +4100,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4180,9 +4346,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4416,9 +4582,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4622,9 +4788,9 @@

    Parses the response from a request to the token endpoint

    @@ -4722,9 +4888,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4807,9 +4973,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4910,6 +5076,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5148,6 +5383,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5170,6 +5406,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5183,6 +5420,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Twitch.html b/classes/chillerlan-OAuth-Providers-Twitch.html index 84fc9ea..33c6277 100644 --- a/classes/chillerlan-OAuth-Providers-Twitch.html +++ b/classes/chillerlan-OAuth-Providers-Twitch.html @@ -205,7 +205,7 @@

    -
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -609,17 +609,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -765,6 +764,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -857,6 +863,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1795,9 +1808,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1987,9 +2000,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -2037,9 +2050,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2385,9 +2398,9 @@

    @@ -2459,9 +2472,9 @@

    @@ -2536,9 +2549,9 @@

    @@ -2615,9 +2628,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2858,9 +2871,9 @@

    @@ -2925,9 +2938,9 @@

    @@ -3053,9 +3066,9 @@

    @@ -3123,7 +3136,7 @@

    @@ -3297,23 +3310,23 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -3322,7 +3335,14 @@
    Parameters
    $token - : AccessToken|null + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null = null
    @@ -3332,7 +3352,7 @@
    Parameters
    Tags - +
    @@ -3341,16 +3361,9 @@
    -

    \chillerlan\OAuth\Core\TokenInvalidate

    +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    -
    -
    - codeCoverageIgnore -
    -
    - -
    throws @@ -3374,23 +3387,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -3409,15 +3422,32 @@
    Parameters
    Tags - +
    - inheritDoc + implements
    +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + throws +
    +
    + ProviderException +
    @@ -3442,7 +3472,7 @@

    @@ -3499,9 +3529,9 @@

    @@ -3742,9 +3772,9 @@

    @@ -3819,9 +3849,9 @@

    @@ -4025,9 +4055,9 @@

    @@ -4601,9 +4631,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4663,9 +4693,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4769,6 +4799,73 @@

    +
    + + +
    +
    Return values
    + array<string|int, mixed> +
    + +

    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + +
    @@ -4885,9 +4982,9 @@

    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4954,9 +5051,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -5190,9 +5287,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5396,9 +5493,9 @@

    Parses the response from a request to the token endpoint

    @@ -5496,9 +5593,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5682,6 +5779,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5941,8 +6107,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
    • -
  • invalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5964,6 +6130,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5977,6 +6144,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-TwitterCC.html b/classes/chillerlan-OAuth-Providers-TwitterCC.html index 1eb315d..05b4989 100644 --- a/classes/chillerlan-OAuth-Providers-TwitterCC.html +++ b/classes/chillerlan-OAuth-Providers-TwitterCC.html @@ -477,6 +477,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -620,6 +626,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -712,6 +725,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1158,9 +1178,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1208,9 +1228,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1573,9 +1593,9 @@

    @@ -1647,9 +1667,9 @@

    @@ -1724,9 +1744,9 @@

    @@ -2127,9 +2147,9 @@

    @@ -2255,9 +2275,9 @@

    @@ -2325,9 +2345,9 @@

    @@ -2493,6 +2513,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2828,9 +2925,9 @@

    @@ -2905,9 +3002,9 @@

    @@ -3111,9 +3208,9 @@

    @@ -3687,9 +3784,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3749,9 +3846,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3818,9 +3915,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3865,6 +3962,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4042,9 +4208,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4278,9 +4444,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4484,9 +4650,9 @@

    Parses the response from a request to the token endpoint

    @@ -4584,9 +4750,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4669,9 +4835,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4772,6 +4938,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5007,6 +5242,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • refreshAccessToken()
  • request()
    • @@ -5028,6 +5264,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5041,6 +5278,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-Vimeo.html b/classes/chillerlan-OAuth-Providers-Vimeo.html index bb65468..af42ddd 100644 --- a/classes/chillerlan-OAuth-Providers-Vimeo.html +++ b/classes/chillerlan-OAuth-Providers-Vimeo.html @@ -198,7 +198,7 @@

    -
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, +
    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")
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
    @@ -542,17 +542,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    me() @@ -698,6 +697,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -790,6 +796,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1638,9 +1651,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1688,9 +1701,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -2036,9 +2049,9 @@

    @@ -2110,9 +2123,9 @@

    @@ -2187,9 +2200,9 @@

    @@ -2266,9 +2279,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2509,9 +2522,9 @@

    @@ -2576,9 +2589,9 @@

    @@ -2704,9 +2717,9 @@

    @@ -2774,9 +2787,9 @@

    @@ -2949,23 +2962,22 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken|null $token = null ][, string|null $type = null ]) : bool
    @@ -2978,39 +2990,29 @@
    Parameters
    = null
    +
    +
    + $type + : string|null + = null
    +
    +

    Tags - +
    - implements -
    -
    - -

    \chillerlan\OAuth\Core\TokenInvalidate

    -
    - -
    -
    - codeCoverageIgnore + inheritDoc
    -
    -
    - throws -
    -
    - ProviderException - -
    @@ -3026,23 +3028,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken|null $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -3061,15 +3063,32 @@
    Parameters
    Tags - +
    - inheritDoc + implements
    +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + throws +
    +
    + ProviderException +
    @@ -3151,9 +3170,9 @@

    @@ -3394,9 +3413,9 @@

    @@ -3471,9 +3490,9 @@

    @@ -3677,9 +3696,9 @@

    @@ -4253,9 +4272,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -4315,9 +4334,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4384,9 +4403,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4431,6 +4450,75 @@

    Return values
    array<string|int, mixed>
    +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4608,9 +4696,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4844,9 +4932,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -5050,9 +5138,9 @@

    Parses the response from a request to the token endpoint

    @@ -5150,9 +5238,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -5235,9 +5323,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5338,6 +5426,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5587,8 +5744,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • -
  • InvalidateAccessToken()
  • invalidateAccessToken()
    • +
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
  • request()
    • @@ -5610,6 +5767,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5623,6 +5781,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-WordPress.html b/classes/chillerlan-OAuth-Providers-WordPress.html index 7607c88..19f8565 100644 --- a/classes/chillerlan-OAuth-Providers-WordPress.html +++ b/classes/chillerlan-OAuth-Providers-WordPress.html @@ -463,6 +463,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -613,6 +619,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -705,6 +718,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1027,9 +1047,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1219,9 +1239,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1269,9 +1289,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1634,9 +1654,9 @@

    @@ -1708,9 +1728,9 @@

    @@ -1785,9 +1805,9 @@

    @@ -1864,9 +1884,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2107,9 +2127,9 @@

    @@ -2174,9 +2194,9 @@

    @@ -2302,9 +2322,9 @@

    @@ -2372,9 +2392,9 @@

    @@ -2540,6 +2560,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -2932,9 +3029,9 @@

    @@ -3009,9 +3106,9 @@

    @@ -3215,9 +3312,9 @@

    @@ -3791,9 +3888,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3853,9 +3950,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3922,9 +4019,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3969,6 +4066,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4146,9 +4312,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4382,9 +4548,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4588,9 +4754,9 @@

    Parses the response from a request to the token endpoint

    @@ -4688,9 +4854,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4773,9 +4939,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4876,6 +5042,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5113,6 +5348,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5135,6 +5371,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5148,6 +5385,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuth-Providers-YouTube.html b/classes/chillerlan-OAuth-Providers-YouTube.html index 179e210..fe60f56 100644 --- a/classes/chillerlan-OAuth-Providers-YouTube.html +++ b/classes/chillerlan-OAuth-Providers-YouTube.html @@ -482,6 +482,12 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    +
    + invalidateAccessToken() + +  : bool +
    +
    InvalidateAccessToken() @@ -632,6 +638,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -724,6 +737,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1168,9 +1188,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1360,9 +1380,9 @@

    An optional PAR (Pushed Authorization Request) endpoint URL

    @@ -1410,9 +1430,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1777,9 +1797,9 @@

    @@ -1851,9 +1871,9 @@

    @@ -1928,9 +1948,9 @@

    @@ -2007,9 +2027,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2250,9 +2270,9 @@

    @@ -2317,9 +2337,9 @@

    @@ -2445,9 +2465,9 @@

    @@ -2515,9 +2535,9 @@

    @@ -2683,6 +2703,83 @@

    Return values
    string|null + +
    +

    + invalidateAccessToken() + + +

    + + + + + public + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null + = null
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + implements +
    +
    + +

    \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken()

    +
    + +
    +
    + throws +
    +
    + ProviderException + + +
    +
    + +
    +
    Return values
    + bool +
    +
    @@ -3075,9 +3172,9 @@

    @@ -3152,9 +3249,9 @@

    @@ -3358,9 +3455,9 @@

    @@ -3934,9 +4031,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3996,9 +4093,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -4065,9 +4162,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -4112,6 +4209,75 @@

    Return values
    array<string|int, mixed> +
    +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4289,9 +4455,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4525,9 +4691,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4731,9 +4897,9 @@

    Parses the response from a request to the token endpoint

    @@ -4831,9 +4997,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4916,9 +5082,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -5019,6 +5185,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5260,6 +5495,7 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • +
  • invalidateAccessToken()
  • InvalidateAccessToken()
  • me()
  • refreshAccessToken()
    • @@ -5282,6 +5518,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5295,6 +5532,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuthTest-Providers-DummyOAuth1Provider.html b/classes/chillerlan-OAuthTest-Providers-DummyOAuth1Provider.html index 7441604..31a717b 100644 --- a/classes/chillerlan-OAuthTest-Providers-DummyOAuth1Provider.html +++ b/classes/chillerlan-OAuthTest-Providers-DummyOAuth1Provider.html @@ -179,7 +179,7 @@

    -
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    +
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    @@ -2009,7 +2009,7 @@

    public - invalidateAccessToken([AccessToken $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -2022,6 +2022,13 @@

    Parameters
    = null
    +
    +
    + $type + : string|null + = null
    +
    +
    diff --git a/classes/chillerlan-OAuthTest-Providers-DummyOAuth2Provider.html b/classes/chillerlan-OAuthTest-Providers-DummyOAuth2Provider.html index 67ca0f2..158b1f8 100644 --- a/classes/chillerlan-OAuthTest-Providers-DummyOAuth2Provider.html +++ b/classes/chillerlan-OAuthTest-Providers-DummyOAuth2Provider.html @@ -179,7 +179,7 @@

    -
    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")
    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)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    +
    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")
    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)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    @@ -452,17 +452,16 @@

    Returns the link to the page where a user can revoke access tokens, or null if the value is not set
    - InvalidateAccessToken() + invalidateAccessToken()  : bool
    - invalidateAccessToken() + InvalidateAccessToken()  : bool
    -
    Allows to invalidate an access token
    refreshAccessToken() @@ -601,6 +600,13 @@

    prepares the request body parameters for the client credentials token request
    +
    + getInvalidateAccessTokenBodyParams() + +  : array<string|int, mixed> +
    +
    Prepares the body for a token revocation request
    +
    getMeResponseData() @@ -693,6 +699,13 @@

    prepares and sends the request to the provider's "me" endpoint and returns a ResponseInterface
    +
    + sendTokenInvalidateRequest() + +  : ResponseInterface +
    +
    Prepares and sends a request to the token invalidation endpoint
    +
    setRequestBody() @@ -1019,9 +1032,9 @@

    An optional client credentials token endpoint in case the provider supports ClientCredentials.

    @@ -1245,9 +1258,9 @@

    An optional refresh token endpoint in case the provider supports TokenRefresh.

    @@ -1593,9 +1606,9 @@

    @@ -1667,9 +1680,9 @@

    @@ -1744,9 +1757,9 @@

    @@ -1823,9 +1836,9 @@

    Obtains an OAuth2 access token with the given $code, verifies the $state @@ -2066,9 +2079,9 @@

    @@ -2133,9 +2146,9 @@

    @@ -2261,9 +2274,9 @@

    @@ -2331,9 +2344,9 @@

    @@ -2506,23 +2519,22 @@

    Return values
    -public " > -

    - InvalidateAccessToken() - +

    + invalidateAccessToken() +

    public - InvalidateAccessToken([AccessToken|null $token = null ]) : bool + invalidateAccessToken([AccessToken $token = null ][, string|null $type = null ]) : bool
    @@ -2531,7 +2543,14 @@
    Parameters
    $token - : AccessToken|null + : AccessToken + = null
    +
    + +
    +
    + $type + : string|null = null
    @@ -2541,33 +2560,16 @@
    Parameters
    Tags - +
    - implements -
    -
    - -

    \chillerlan\OAuth\Core\TokenInvalidate

    -
    - -
    -
    - codeCoverageIgnore + inheritDoc
    -
    -
    - throws -
    -
    - ProviderException - -
    @@ -2583,23 +2585,23 @@
    Return values
    -public " > -

    - invalidateAccessToken() - +

    + InvalidateAccessToken() +

    -

    Allows to invalidate an access token

    - + public - invalidateAccessToken([AccessToken $token = null ]) : bool + InvalidateAccessToken([AccessToken|null $token = null ]) : bool
    @@ -2608,7 +2610,7 @@
    Parameters
    $token - : AccessToken + : AccessToken|null = null
    @@ -2618,15 +2620,32 @@
    Parameters
    Tags - +
    - inheritDoc + implements
    +

    \chillerlan\OAuth\Core\TokenInvalidate

    +
    + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + throws +
    +
    + ProviderException +
    @@ -2651,9 +2670,9 @@

    @@ -2894,9 +2913,9 @@

    @@ -2971,9 +2990,9 @@

    @@ -3177,9 +3196,9 @@

    @@ -3753,9 +3772,9 @@

    OAuth2Provider.php : - 210 + 211 - +

    prepares the request body parameters for the access token request

    @@ -3815,9 +3834,9 @@

    OAuth2Provider.php : - 75 + 76 - +

    prepares the query parameters for the auth URL

    @@ -3884,9 +3903,9 @@

    OAuth2Provider.php : - 323 + 324 - +

    prepares the request body parameters for the client credentials token request

    @@ -3931,6 +3950,75 @@

    Return values
    array<string|int, mixed> + +
    +

    + getInvalidateAccessTokenBodyParams() + + +

    + + +

    Prepares the body for a token revocation request

    + + + protected + getInvalidateAccessTokenBodyParams(AccessToken $token, string $type) : array<string|int, mixed> + +
    +
    + +
    Parameters
    +
    +
    + $token + : AccessToken +
    +
    + +
    +
    + $type + : string +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    + +
    +
    Return values
    + array<string|int, mixed> +
    +
    OAuth2Provider.php : - 595 + 671 - +

    Parses the response from the PAR request and returns the query parameters for the authorization URL

    @@ -4108,9 +4196,9 @@

    OAuth2Provider.php : - 399 + 400 - +

    prepares the request body parameters for the token refresh

    @@ -4344,9 +4432,9 @@

    extracts the data from the access token response and returns an array with the key->value pairs contained

    @@ -4550,9 +4638,9 @@

    Parses the response from a request to the token endpoint

    @@ -4650,9 +4738,9 @@

    sends a request to the access/refresh token endpoint $url with the given $body as form data

    @@ -4735,9 +4823,9 @@

    OAuth2Provider.php : - 338 + 339 - +

    sends a request to the client credentials endpoint, using basic authentication

    @@ -4838,6 +4926,75 @@

    Parameters
    +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + sendTokenInvalidateRequest() + + +

    + + +

    Prepares and sends a request to the token invalidation endpoint

    + + + protected + sendTokenInvalidateRequest(string $url, array<string|int, mixed> $body) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $url + : string +
    +
    + +
    +
    + $body + : array<string|int, mixed> +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + see +
    +
    + OAuth2Provider::invalidateAccessToken() + + +
    +
    +
    Return values
    ResponseInterface @@ -5075,8 +5232,8 @@
    Return values
  • getRequestAuthorization()
  • getStorage()
  • getUserRevokeURL()
    • -
  • InvalidateAccessToken()
  • invalidateAccessToken()
    • +
  • InvalidateAccessToken()
  • refreshAccessToken()
  • request()
  • sendRequest()
    • @@ -5097,6 +5254,7 @@
    Return values
  • getAccessTokenRequestBodyParams()
  • getAuthorizationURLRequestParams()
  • getClientCredentialsTokenRequestBodyParams()
    • +
  • getInvalidateAccessTokenBodyParams()
  • getMeResponseData()
  • getParAuthorizationURLRequestParams()
  • getRefreshAccessTokenRequestBodyParams()
    • @@ -5110,6 +5268,7 @@
    Return values
  • sendAccessTokenRequest()
  • sendClientCredentialsTokenRequest()
  • sendMeRequest()
    • +
  • sendTokenInvalidateRequest()
  • setRequestBody()
    • diff --git a/classes/chillerlan-OAuthTest-Providers-Unit-StripeTest.html b/classes/chillerlan-OAuthTest-Providers-Unit-StripeTest.html index 28a4227..6fcdafb 100644 --- a/classes/chillerlan-OAuthTest-Providers-Unit-StripeTest.html +++ b/classes/chillerlan-OAuthTest-Providers-Unit-StripeTest.html @@ -637,7 +637,7 @@

    - testTokenInvalidate() + testTokenInvalidate()  : void
    @@ -3141,13 +3141,13 @@

    testTokenInvalidate() - +

    @@ -3857,7 +3857,7 @@

  • testSetCodeVerifierNotSupportedException()
  • testSetCSRFState()
  • testSetCSRFStateNotSupportedException()
    • -
  • testTokenInvalidate()
    • +
  • testTokenInvalidate()
  • testTokenInvalidateNoTokenException()
  • getMockHttpClient()
  • getProviderFQCN()
    • diff --git a/files/src-core-tokeninvalidate.html b/files/src-core-tokeninvalidate.html index fd27e1b..b7c191f 100644 --- a/files/src-core-tokeninvalidate.html +++ b/files/src-core-tokeninvalidate.html @@ -187,7 +187,7 @@

    -
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens
    +
    TokenInvalidate
    Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
    diff --git a/files/src/Core/OAuth2Provider.php.txt b/files/src/Core/OAuth2Provider.php.txt index 5999c66..ca81633 100644 --- a/files/src/Core/OAuth2Provider.php.txt +++ b/files/src/Core/OAuth2Provider.php.txt @@ -17,7 +17,8 @@ use chillerlan\HTTP\Utils\{MessageUtil, QueryUtil, UriUtil}; use chillerlan\OAuth\Providers\ProviderException; use Psr\Http\Message\{RequestInterface, ResponseInterface, UriInterface}; use Throwable; -use function array_merge, date, explode, hash, hash_equals, implode, in_array, is_array, random_int, sodium_bin2base64, sprintf; +use function array_merge, date, explode, hash, hash_equals, implode, in_array, is_array, random_int, + sodium_bin2base64, sprintf, str_contains, strtolower, trim; use const PHP_QUERY_RFC1738, PHP_VERSION_ID, SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING; /** @@ -407,6 +408,81 @@ abstract class OAuth2Provider extends OAuthProvider implements OAuth2Interface{ } + /* + * TokenInvalidate + */ + + /** + * @implements \chillerlan\OAuth\Core\TokenInvalidate::invalidateAccessToken() + * @throws \chillerlan\OAuth\Providers\ProviderException + */ + public function invalidateAccessToken(AccessToken $token = null, string|null $type = null):bool{ + $type = strtolower(trim($type ?? 'access_token')); + + // @link https://datatracker.ietf.org/doc/html/rfc7009#section-2.1 + if(!in_array($type, ['access_token', 'refresh_token'])){ + throw new ProviderException(sprintf('invalid token type "%s"', $type)); + } + + $tokenToInvalidate = ($token ?? $this->storage->getAccessToken($this->name)); + $body = $this->getInvalidateAccessTokenBodyParams($tokenToInvalidate, $type); + $response = $this->sendTokenInvalidateRequest($this->revokeURL, $body); + + // some endpoints may return 204, others 200 with empty body + if(in_array($response->getStatusCode(), [200, 204], true)){ + + // if the token was given via parameter it cannot be deleted from storage + if($token === null){ + $this->storage->clearAccessToken($this->name); + } + + return true; + } + + // ok, let's see if we got a response body + // @link https://datatracker.ietf.org/doc/html/rfc7009#section-2.2.1 + if(str_contains($response->getHeaderLine('content-type'), 'json')){ + $json = MessageUtil::decodeJSON($response); + + if(isset($json['error'])){ + throw new ProviderException($json['error']); + } + } + + return false; + } + + /** + * Prepares and sends a request to the token invalidation endpoint + * + * @see \chillerlan\OAuth\Core\OAuth2Provider::invalidateAccessToken() + */ + protected function sendTokenInvalidateRequest(string $url, array $body):ResponseInterface{ + + $request = $this->requestFactory + ->createRequest('POST', $url) + ->withHeader('Content-Type', 'application/x-www-form-urlencoded') + ; + + // some enpoints may require a basic auth header here + $request = $this->setRequestBody($body, $request); + + return $this->http->sendRequest($request); + } + + /** + * Prepares the body for a token revocation request + * + * @see \chillerlan\OAuth\Core\OAuth2Provider::invalidateAccessToken() + */ + protected function getInvalidateAccessTokenBodyParams(AccessToken $token, string $type):array{ + return [ + 'token' => $token->accessToken, + 'token_type_hint' => $type, + ]; + } + + /* * CSRFToken */ diff --git a/js/searchIndex.js b/js/searchIndex.js index f0a2f57..6b5ef23 100644 --- a/js/searchIndex.js +++ b/js/searchIndex.js @@ -340,6 +340,21 @@ Search.appendIndex( "name": "getRefreshAccessTokenRequestBodyParams", "summary": "prepares\u0020the\u0020request\u0020body\u0020parameters\u0020for\u0020the\u0020token\u0020refresh", "url": "classes/chillerlan-OAuth-Core-OAuth2Provider.html#method_getRefreshAccessTokenRequestBodyParams" + }, { + "fqsen": "\\chillerlan\\OAuth\\Core\\OAuth2Provider\u003A\u003AinvalidateAccessToken\u0028\u0029", + "name": "invalidateAccessToken", + "summary": "", + "url": "classes/chillerlan-OAuth-Core-OAuth2Provider.html#method_invalidateAccessToken" + }, { + "fqsen": "\\chillerlan\\OAuth\\Core\\OAuth2Provider\u003A\u003AsendTokenInvalidateRequest\u0028\u0029", + "name": "sendTokenInvalidateRequest", + "summary": "Prepares\u0020and\u0020sends\u0020a\u0020request\u0020to\u0020the\u0020token\u0020invalidation\u0020endpoint", + "url": "classes/chillerlan-OAuth-Core-OAuth2Provider.html#method_sendTokenInvalidateRequest" + }, { + "fqsen": "\\chillerlan\\OAuth\\Core\\OAuth2Provider\u003A\u003AgetInvalidateAccessTokenBodyParams\u0028\u0029", + "name": "getInvalidateAccessTokenBodyParams", + "summary": "Prepares\u0020the\u0020body\u0020for\u0020a\u0020token\u0020revocation\u0020request", + "url": "classes/chillerlan-OAuth-Core-OAuth2Provider.html#method_getInvalidateAccessTokenBodyParams" }, { "fqsen": "\\chillerlan\\OAuth\\Core\\OAuth2Provider\u003A\u003AsetState\u0028\u0029", "name": "setState", @@ -783,7 +798,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Core\\TokenInvalidate", "name": "TokenInvalidate", - "summary": "Indicates\u0020whether\u0020the\u0020provider\u0020is\u0020capable\u0020of\u0020invalidating\u0020access\u0020tokens", + "summary": "Indicates\u0020whether\u0020the\u0020provider\u0020is\u0020capable\u0020of\u0020invalidating\u0020access\u0020tokens\u0020\u0028RFC\u002D7009\u0020or\u0020proprietary\u0029", "url": "classes/chillerlan-OAuth-Core-TokenInvalidate.html" }, { "fqsen": "\\chillerlan\\OAuth\\Core\\TokenInvalidate\u003A\u003AinvalidateAccessToken\u0028\u0029", @@ -1213,7 +1228,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\BigCartel\u003A\u003AinvalidateAccessToken\u0028\u0029", "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", + "summary": "", "url": "classes/chillerlan-OAuth-Providers-BigCartel.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\BigCartel\u003A\u003AgetAccountID\u0028\u0029", @@ -1608,7 +1623,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\DeviantArt\u003A\u003AinvalidateAccessToken\u0028\u0029", "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", + "summary": "", "url": "classes/chillerlan-OAuth-Providers-DeviantArt.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\DeviantArt\u003A\u003AIDENTIFIER", @@ -1775,16 +1790,16 @@ Search.appendIndex( "name": "Discord", "summary": "Discord\u0020OAuth2", "url": "classes/chillerlan-OAuth-Providers-Discord.html" + }, { + "fqsen": "\\chillerlan\\OAuth\\Providers\\Discord\u003A\u003AgetInvalidateAccessTokenBodyParams\u0028\u0029", + "name": "getInvalidateAccessTokenBodyParams", + "summary": "Prepares\u0020the\u0020body\u0020for\u0020a\u0020token\u0020revocation\u0020request", + "url": "classes/chillerlan-OAuth-Providers-Discord.html#method_getInvalidateAccessTokenBodyParams" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Discord\u003A\u003Ame\u0028\u0029", "name": "me", "summary": "Returns\u0020information\u0020about\u0020the\u0020currently\u0020authenticated\u0020user\u0020\u0028usually\u0020a\u0020\/me\u0020or\u0020\/user\u0020endpoint\u0029.", "url": "classes/chillerlan-OAuth-Providers-Discord.html#method_me" - }, { - "fqsen": "\\chillerlan\\OAuth\\Providers\\Discord\u003A\u003AinvalidateAccessToken\u0028\u0029", - "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", - "url": "classes/chillerlan-OAuth-Providers-Discord.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Discord\u003A\u003AIDENTIFIER", "name": "IDENTIFIER", @@ -3095,6 +3110,11 @@ Search.appendIndex( "name": "getRefreshAccessTokenRequestBodyParams", "summary": "prepares\u0020the\u0020request\u0020body\u0020parameters\u0020for\u0020the\u0020token\u0020refresh", "url": "classes/chillerlan-OAuth-Providers-MusicBrainz.html#method_getRefreshAccessTokenRequestBodyParams" + }, { + "fqsen": "\\chillerlan\\OAuth\\Providers\\MusicBrainz\u003A\u003AgetInvalidateAccessTokenBodyParams\u0028\u0029", + "name": "getInvalidateAccessTokenBodyParams", + "summary": "Prepares\u0020the\u0020body\u0020for\u0020a\u0020token\u0020revocation\u0020request", + "url": "classes/chillerlan-OAuth-Providers-MusicBrainz.html#method_getInvalidateAccessTokenBodyParams" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\MusicBrainz\u003A\u003Arequest\u0028\u0029", "name": "request", @@ -3105,11 +3125,6 @@ Search.appendIndex( "name": "me", "summary": "Returns\u0020information\u0020about\u0020the\u0020currently\u0020authenticated\u0020user\u0020\u0028usually\u0020a\u0020\/me\u0020or\u0020\/user\u0020endpoint\u0029.", "url": "classes/chillerlan-OAuth-Providers-MusicBrainz.html#method_me" - }, { - "fqsen": "\\chillerlan\\OAuth\\Providers\\MusicBrainz\u003A\u003AinvalidateAccessToken\u0028\u0029", - "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", - "url": "classes/chillerlan-OAuth-Providers-MusicBrainz.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\MusicBrainz\u003A\u003AIDENTIFIER", "name": "IDENTIFIER", @@ -3205,11 +3220,6 @@ Search.appendIndex( "name": "me", "summary": "Returns\u0020information\u0020about\u0020the\u0020currently\u0020authenticated\u0020user\u0020\u0028usually\u0020a\u0020\/me\u0020or\u0020\/user\u0020endpoint\u0029.", "url": "classes/chillerlan-OAuth-Providers-NPROne.html#method_me" - }, { - "fqsen": "\\chillerlan\\OAuth\\Providers\\NPROne\u003A\u003AinvalidateAccessToken\u0028\u0029", - "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", - "url": "classes/chillerlan-OAuth-Providers-NPROne.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\NPROne\u003A\u003AIDENTIFIER", "name": "IDENTIFIER", @@ -3795,16 +3805,16 @@ Search.appendIndex( "name": "Reddit", "summary": "Reddit\u0020OAuth2", "url": "classes/chillerlan-OAuth-Providers-Reddit.html" + }, { + "fqsen": "\\chillerlan\\OAuth\\Providers\\Reddit\u003A\u003AsendTokenInvalidateRequest\u0028\u0029", + "name": "sendTokenInvalidateRequest", + "summary": "Prepares\u0020and\u0020sends\u0020a\u0020request\u0020to\u0020the\u0020token\u0020invalidation\u0020endpoint", + "url": "classes/chillerlan-OAuth-Providers-Reddit.html#method_sendTokenInvalidateRequest" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Reddit\u003A\u003Ame\u0028\u0029", "name": "me", "summary": "Returns\u0020information\u0020about\u0020the\u0020currently\u0020authenticated\u0020user\u0020\u0028usually\u0020a\u0020\/me\u0020or\u0020\/user\u0020endpoint\u0029.", "url": "classes/chillerlan-OAuth-Providers-Reddit.html#method_me" - }, { - "fqsen": "\\chillerlan\\OAuth\\Providers\\Reddit\u003A\u003AinvalidateAccessToken\u0028\u0029", - "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", - "url": "classes/chillerlan-OAuth-Providers-Reddit.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Reddit\u003A\u003AIDENTIFIER", "name": "IDENTIFIER", @@ -4621,10 +4631,10 @@ Search.appendIndex( "summary": "Returns\u0020information\u0020about\u0020the\u0020currently\u0020authenticated\u0020user\u0020\u0028usually\u0020a\u0020\/me\u0020or\u0020\/user\u0020endpoint\u0029.", "url": "classes/chillerlan-OAuth-Providers-Stripe.html#method_me" }, { - "fqsen": "\\chillerlan\\OAuth\\Providers\\Stripe\u003A\u003AinvalidateAccessToken\u0028\u0029", - "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", - "url": "classes/chillerlan-OAuth-Providers-Stripe.html#method_invalidateAccessToken" + "fqsen": "\\chillerlan\\OAuth\\Providers\\Stripe\u003A\u003AgetInvalidateAccessTokenBodyParams\u0028\u0029", + "name": "getInvalidateAccessTokenBodyParams", + "summary": "Prepares\u0020the\u0020body\u0020for\u0020a\u0020token\u0020revocation\u0020request", + "url": "classes/chillerlan-OAuth-Providers-Stripe.html#method_getInvalidateAccessTokenBodyParams" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Stripe\u003A\u003AIDENTIFIER", "name": "IDENTIFIER", @@ -4815,6 +4825,11 @@ Search.appendIndex( "name": "sendClientCredentialsTokenRequest", "summary": "sends\u0020a\u0020request\u0020to\u0020the\u0020client\u0020credentials\u0020endpoint,\u0020using\u0020basic\u0020authentication", "url": "classes/chillerlan-OAuth-Providers-Twitch.html#method_sendClientCredentialsTokenRequest" + }, { + "fqsen": "\\chillerlan\\OAuth\\Providers\\Twitch\u003A\u003AgetInvalidateAccessTokenBodyParams\u0028\u0029", + "name": "getInvalidateAccessTokenBodyParams", + "summary": "Prepares\u0020the\u0020body\u0020for\u0020a\u0020token\u0020revocation\u0020request", + "url": "classes/chillerlan-OAuth-Providers-Twitch.html#method_getInvalidateAccessTokenBodyParams" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Twitch\u003A\u003AgetRequestAuthorization\u0028\u0029", "name": "getRequestAuthorization", @@ -4825,11 +4840,6 @@ Search.appendIndex( "name": "me", "summary": "Returns\u0020information\u0020about\u0020the\u0020currently\u0020authenticated\u0020user\u0020\u0028usually\u0020a\u0020\/me\u0020or\u0020\/user\u0020endpoint\u0029.", "url": "classes/chillerlan-OAuth-Providers-Twitch.html#method_me" - }, { - "fqsen": "\\chillerlan\\OAuth\\Providers\\Twitch\u003A\u003AinvalidateAccessToken\u0028\u0029", - "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", - "url": "classes/chillerlan-OAuth-Providers-Twitch.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Twitch\u003A\u003AIDENTIFIER", "name": "IDENTIFIER", @@ -5108,7 +5118,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Vimeo\u003A\u003AinvalidateAccessToken\u0028\u0029", "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", + "summary": "", "url": "classes/chillerlan-OAuth-Providers-Vimeo.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuth\\Providers\\Vimeo\u003A\u003AIDENTIFIER", @@ -6048,7 +6058,7 @@ Search.appendIndex( }, { "fqsen": "\\chillerlan\\OAuthTest\\Providers\\DummyOAuth2Provider\u003A\u003AinvalidateAccessToken\u0028\u0029", "name": "invalidateAccessToken", - "summary": "Allows\u0020to\u0020invalidate\u0020an\u0020access\u0020token", + "summary": "", "url": "classes/chillerlan-OAuthTest-Providers-DummyOAuth2Provider.html#method_invalidateAccessToken" }, { "fqsen": "\\chillerlan\\OAuthTest\\Providers\\DummyOAuth2Provider\u003A\u003AIDENTIFIER", @@ -7580,6 +7590,11 @@ Search.appendIndex( "name": "StripeTest", "summary": "", "url": "classes/chillerlan-OAuthTest-Providers-Unit-StripeTest.html" + }, { + "fqsen": "\\chillerlan\\OAuthTest\\Providers\\Unit\\StripeTest\u003A\u003AtestTokenInvalidate\u0028\u0029", + "name": "testTokenInvalidate", + "summary": "", + "url": "classes/chillerlan-OAuthTest-Providers-Unit-StripeTest.html#method_testTokenInvalidate" }, { "fqsen": "\\chillerlan\\OAuthTest\\Providers\\Unit\\Tumblr2Test", "name": "Tumblr2Test", diff --git a/namespaces/chillerlan-oauth-core.html b/namespaces/chillerlan-oauth-core.html index ae4f068..7b68712 100644 --- a/namespaces/chillerlan-oauth-core.html +++ b/namespaces/chillerlan-oauth-core.html @@ -140,7 +140,7 @@

    -
    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
    Indicates whether the service can provide information about the currently authenticated user, +
    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 (RFC-7009 or proprietary)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.

    diff --git a/packages/Application.html b/packages/Application.html index c094ab9..5c94308 100644 --- a/packages/Application.html +++ b/packages/Application.html @@ -138,7 +138,7 @@

    -
    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
    Indicates whether the service can provide information about the currently authenticated user, +
    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 (RFC-7009 or proprietary)
    TokenRefresh
    Indicates whether the provider is capable of the OAuth2 token refresh.
    UserInfo
    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