ApplicationDefaultCredentials obtains the default credentials for authorizing a request to a Google service.

Application Default Credentials are described here:
https://developers.google.com/accounts/docs/application-default-credentials

This class implements the search for the application default credentials as
described in the link.

It provides three factory methods:

  • get returns the computed credentials object

  • getSubscriber returns an AuthTokenSubscriber built from the credentials object

  • getMiddleware returns an AuthTokenMiddleware built from the credentials object

This allows it to be used as follows with GuzzleHttp\Client:

use Google\Auth\ApplicationDefaultCredentials;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;

$middleware = ApplicationDefaultCredentials::getMiddleware(

  'https://www.googleapis.com/auth/taskqueue'

);
$stack = HandlerStack::create();
$stack->push($middleware);

$client = new Client([

  'handler' => $stack,
  'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
  'auth' => 'google_auth' // authorize all requests

]);

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

CloneableInstantiable
Methods
public static getCredentials( $scope = NULL, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenMiddleware which will fetch an access token to use in the Authorization header. The middleware is configured with the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $scope is used to in creating the credentials instance if
this does not fallback to the Compute Engine defaults.

public static getIdTokenCredentials( $targetAudience, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains the default FetchAuthTokenInterface implementation to use in this environment, configured with a $targetAudience for fetching an ID token.

  • return Google\Auth\CredentialsLoader
  • throws DomainException if no implementation can be obtained.
  • throws InvalidArgumentException if JSON "type" key is invalid
public static getIdTokenMiddleware( $targetAudience, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenMiddleware which will fetch an ID token to use in the Authorization header. The middleware is configured with the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $targetAudience is used to set the "aud" on the resulting
ID token.

  • return AuthTokenMiddleware
  • throws DomainException if no implementation can be obtained.
public static getMiddleware( $scope = NULL, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenMiddleware that uses the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $scope is used to in creating the credentials instance if
this does not fallback to the compute engine defaults.

  • return AuthTokenMiddleware
  • throws DomainException if no implementation can be obtained.
public static getSubscriber( $scope = NULL, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenSubscriber that uses the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $scope is used to in creating the credentials instance if
this does not fallback to the compute engine defaults.

  • return AuthTokenSubscriber
  • throws DomainException if no implementation can be obtained.
Methods
private static notFound()
Methods
public static getCredentials( $scope = NULL, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenMiddleware which will fetch an access token to use in the Authorization header. The middleware is configured with the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $scope is used to in creating the credentials instance if
this does not fallback to the Compute Engine defaults.

public static getIdTokenCredentials( $targetAudience, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains the default FetchAuthTokenInterface implementation to use in this environment, configured with a $targetAudience for fetching an ID token.

  • return Google\Auth\CredentialsLoader
  • throws DomainException if no implementation can be obtained.
  • throws InvalidArgumentException if JSON "type" key is invalid
public static getIdTokenMiddleware( $targetAudience, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenMiddleware which will fetch an ID token to use in the Authorization header. The middleware is configured with the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $targetAudience is used to set the "aud" on the resulting
ID token.

  • return AuthTokenMiddleware
  • throws DomainException if no implementation can be obtained.
public static getMiddleware( $scope = NULL, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenMiddleware that uses the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $scope is used to in creating the credentials instance if
this does not fallback to the compute engine defaults.

  • return AuthTokenMiddleware
  • throws DomainException if no implementation can be obtained.
public static getSubscriber( $scope = NULL, ?callable $httpHandler = NULL, ?array $cacheConfig = NULL, ?Psr\Cache\CacheItemPoolInterface $cache = NULL)
 
Obtains an AuthTokenSubscriber that uses the default FetchAuthTokenInterface implementation to use in this environment.

If supplied, $scope is used to in creating the credentials instance if
this does not fallback to the compute engine defaults.

  • return AuthTokenSubscriber
  • throws DomainException if no implementation can be obtained.
private static notFound()
© 2020 Bruce Wells
Search Namespaces \ Classes
ConfigurationNumbers (0-9.) only