class ScopedAccessTokenMiddleware (View source)

ScopedAccessTokenMiddleware is a Guzzle Middleware that adds an Authorization header provided by a closure.

The closure returns an access token, taking the scope, either a single string or an array of strings, as its value. If provided, a cache will be used to preserve the access token for a given lifetime.

Requests will be accessed with the authorization header:

'authorization' 'Bearer '

Traits

Constants

DEFAULT_CACHE_LIFETIME

Methods

__construct(callable $tokenFunc, array|string $scopes, array $cacheConfig = null, CacheItemPoolInterface $cache = null)

Creates a new ScopedAccessTokenMiddleware.

__invoke(callable $handler)

Updates the request with an Authorization header when auth is 'scoped'.

Details

__construct(callable $tokenFunc, array|string $scopes, array $cacheConfig = null, CacheItemPoolInterface $cache = null)

Creates a new ScopedAccessTokenMiddleware.

Parameters

callable $tokenFunc

a token generator function

array|string $scopes

the token authentication scopes

array $cacheConfig

configuration for the cache when it's present

CacheItemPoolInterface $cache

an implementation of CacheItemPoolInterface

Closure __invoke(callable $handler)

Updates the request with an Authorization header when auth is 'scoped'.

E.g this could be used to authenticate using the AppEngine AppIdentityService.

use google\appengine\api\app_identity\AppIdentityService; use Google\Auth\Middleware\ScopedAccessTokenMiddleware; use GuzzleHttp\Client; use GuzzleHttp\HandlerStack;

$scope = 'https://www.googleapis.com/auth/taskqueue' $middleware = new ScopedAccessTokenMiddleware( 'AppIdentityService::getAccessToken', $scope, [ 'prefix' => 'Google\Auth\ScopedAccessToken::' ], $cache = new Memcache() ); $stack = HandlerStack::create(); $stack->push($middleware);

$client = new Client([ 'handler' => $stack, 'base_url' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', 'auth' => 'scoped' // authorize all requests ]);

$res = $client->get('myproject/taskqueues/myqueue');

Parameters

callable $handler

Return Value

Closure