Documentation

AppIdentityCredentials extends CredentialsLoader

in package

• Application

implements SignBlobInterface, ProjectIdProviderInterface

AppIdentityCredentials supports authorization on Google App Engine.

use Google\Auth\Credentials\AppIdentityCredentials;
use Google\Auth\Middleware\AuthTokenMiddleware;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;

$gae = new AppIdentityCredentials('https://www.googleapis.com/auth/books');
$middleware = new AuthTokenMiddleware($gae);
$stack = HandlerStack::create();
$stack->push($middleware);

$client = new Client([
    'handler' => $stack,
    'base_uri' => 'https://www.googleapis.com/books/v1',
    'auth' => 'google_auth'
]);

$res = $client->get('volumes?q=Henry+David+Thoreau&country=US');

Table of Contents

Interfaces

SignBlobInterface

Describes a class which supports signing arbitrary strings.

ProjectIdProviderInterface

Describes a Credentials object which supports fetching the project ID.

Constants

ENV_VAR  = 'GOOGLE_APPLICATION_CREDENTIALS'

NON_WINDOWS_WELL_KNOWN_PATH_BASE  = '.config'

TOKEN_CREDENTIAL_URI  = 'https://oauth2.googleapis.com/token'

WELL_KNOWN_PATH  = 'gcloud/application_default_credentials.json'

Properties

$lastReceivedToken  : array<string|int, mixed>

Result of fetchAuthToken.

$clientName  : string

$scope  : array<string|int, mixed>

Array of OAuth2 scopes to be requested.

Methods

__construct()  : mixed

fetchAuthToken()  : array<string|int, mixed>

Implements FetchAuthTokenInterface#fetchAuthToken.

fromEnv()  : array<string|int, mixed>|null

Load a JSON key from the path specified in the environment.

fromWellKnownFile()  : array<string|int, mixed>|null

Load a JSON key from a well known path.

getCacheKey()  : string

Caching is handled by the underlying AppIdentityService, return empty string to prevent caching.

getClientName()  : string

Get the client name from AppIdentityService.

getLastReceivedToken()  : array<string|int, mixed>|null

Returns an associative array with the token and expiration time.

getProjectId()  : string|null

Get the project ID from AppIdentityService.

getUpdateMetadataFunc()  : array<string|int, mixed>

export a callback function which updates runtime metadata.

makeCredentials()  : ServiceAccountCredentials|UserRefreshCredentials

Create a new Credentials instance.

makeHttpClient()  : Client

Create an authorized HTTP Client from an instance of FetchAuthTokenInterface.

makeInsecureCredentials()  : InsecureCredentials

Create a new instance of InsecureCredentials.

onAppEngine()  : bool

Determines if this an App Engine instance, by accessing the SERVER_SOFTWARE environment variable (prod) or the APPENGINE_RUNTIME environment variable (dev).

signBlob()  : string

Sign a string using AppIdentityService.

updateMetadata()  : array<string|int, mixed>

Updates metadata with the authorization token.

checkAppEngineContext()  : mixed

getGuzzleMajorVersion()  : int

Returns the currently available major Guzzle version.

isOnWindows()  : bool

unableToReadEnv()  : string