A

AccessTokenClass in namespace Google\Auth

Wrapper around Google Access Tokens which provides convenience functions.

ApplicationDefaultCredentialsClass in namespace Google\Auth

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

AwsNativeSourceClass in namespace Google\Auth\CredentialSource

Authenticates requests using AWS credentials.

AppIdentityCredentialsClass in namespace Google\Auth\Credentials
$ ServiceAccountCredentials#authProperty in class ServiceAccountCredentials

The OAuth2 instance used to conduct authorization.

$ ServiceAccountJwtAccessCredentials#authProperty in class ServiceAccountJwtAccessCredentials

The OAuth2 instance used to conduct authorization.

$ UserRefreshCredentials#authProperty in class UserRefreshCredentials

The OAuth2 instance used to conduct authorization.

Guzzle6HttpHandler::async() — Method in class Guzzle6HttpHandler

Accepts a PSR-7 request and an array of options and returns a PromiseInterface

AuthTokenMiddlewareClass in namespace Google\Auth\Middleware

AuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header provided by an object implementing FetchAuthTokenInterface.

B

HttpHandlerFactory::build() — Method in class HttpHandlerFactory

Builds out a default http handler for the installed version of guzzle.

OAuth2::buildFullAuthorizationUri() — Method in class OAuth2

Builds the authorization Uri that the user should be redirected to.

C

AccessToken::callJwtStatic() — Method in class AccessToken

Provide a hook to mock calls to the JWT static methods.

AccessToken::callSimpleJwtDecode() — Method in class AccessToken

Provide a hook to mock calls to the JWT static methods.

CacheTraitClass in namespace Google\Auth
Item::currentTime() — Method in class Item
MemoryCacheItemPool::clear() — Method in class MemoryCacheItemPool
{@inheritdoc}
MemoryCacheItemPool::commit() — Method in class MemoryCacheItemPool
{@inheritdoc}
SysVCacheItemPool::clear() — Method in class SysVCacheItemPool
{@inheritdoc}
SysVCacheItemPool::commit() — Method in class SysVCacheItemPool
{@inheritdoc}
TypedItem::currentTime() — Method in class TypedItem
CredentialsLoaderClass in namespace Google\Auth

CredentialsLoader contains the behaviour used to locate and find default credentials files on the file system.

D

MemoryCacheItemPool::deleteItem() — Method in class MemoryCacheItemPool
{@inheritdoc}
MemoryCacheItemPool::deleteItems() — Method in class MemoryCacheItemPool
{@inheritdoc}
SysVCacheItemPool::deleteItem() — Method in class SysVCacheItemPool
{@inheritdoc}
SysVCacheItemPool::deleteItems() — Method in class SysVCacheItemPool
{@inheritdoc}

E

Item::expiresAt() — Method in class Item
{@inheritdoc}
Item::expiresAfter() — Method in class Item
{@inheritdoc}
TypedItem::expiresAt() — Method in class TypedItem
{@inheritdoc}
TypedItem::expiresAfter() — Method in class TypedItem
{@inheritdoc}
ExternalAccountCredentialsClass in namespace Google\Auth\Credentials
ExternalAccountCredentialSourceInterfaceClass in namespace Google\Auth

F

AwsNativeSource::fetchSubjectToken() — Method in class AwsNativeSource
FileSourceClass in namespace Google\Auth\CredentialSource

Retrieve a token from a file.

FileSource::fetchSubjectToken() — Method in class FileSource
UrlSource::fetchSubjectToken() — Method in class UrlSource
CredentialsLoader::fromEnv() — Method in class CredentialsLoader

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

CredentialsLoader::fromWellKnownFile() — Method in class CredentialsLoader

Load a JSON key from a well known path.

AppIdentityCredentials::fetchAuthToken() — Method in class AppIdentityCredentials

Implements FetchAuthTokenInterface#fetchAuthToken.

ExternalAccountCredentials::fetchAuthToken() — Method in class ExternalAccountCredentials
GCECredentials::fetchAuthToken() — Method in class GCECredentials

Implements FetchAuthTokenInterface#fetchAuthToken.

ImpersonatedServiceAccountCredentials::fetchAuthToken() — Method in class ImpersonatedServiceAccountCredentials
InsecureCredentials::fetchAuthToken() — Method in class InsecureCredentials

Fetches the auth token. In this case it returns an empty string.

ServiceAccountCredentials::fetchAuthToken() — Method in class ServiceAccountCredentials
ServiceAccountJwtAccessCredentials::fetchAuthToken() — Method in class ServiceAccountJwtAccessCredentials

Implements FetchAuthTokenInterface#fetchAuthToken.

UserRefreshCredentials::fetchAuthToken() — Method in class UserRefreshCredentials
ExternalAccountCredentialSourceInterface::fetchSubjectToken() — Method in class ExternalAccountCredentialSourceInterface
FetchAuthTokenCacheClass in namespace Google\Auth

A class to implement caching for any object implementing FetchAuthTokenInterface

FetchAuthTokenCache::fetchAuthToken() — Method in class FetchAuthTokenCache

Implements FetchAuthTokenInterface#fetchAuthToken.

FetchAuthTokenInterfaceClass in namespace Google\Auth

An interface implemented by objects that can fetch auth tokens.

FetchAuthTokenInterface::fetchAuthToken() — Method in class FetchAuthTokenInterface

Fetches the auth tokens based on the current state.

OAuth2::fetchAuthToken() — Method in class OAuth2

Fetches the auth tokens based on the current state.

G

ApplicationDefaultCredentials::getSubscriber() — Method in class ApplicationDefaultCredentials
ApplicationDefaultCredentials::getMiddleware() — Method in class ApplicationDefaultCredentials

Obtains an AuthTokenMiddleware that uses the default FetchAuthTokenInterface implementation to use in this environment.

ApplicationDefaultCredentials::getCredentials() — Method in class ApplicationDefaultCredentials

Obtains the default FetchAuthTokenInterface implementation to use in this environment.

ApplicationDefaultCredentials::getIdTokenMiddleware() — Method in class ApplicationDefaultCredentials

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.

ApplicationDefaultCredentials::getProxyIdTokenMiddleware() — Method in class ApplicationDefaultCredentials

Obtains an ProxyAuthTokenMiddleware 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.

ApplicationDefaultCredentials::getIdTokenCredentials() — Method in class ApplicationDefaultCredentials

Obtains the default FetchAuthTokenInterface implementation to use in this environment, configured with a $targetAudience for fetching an ID token.

Item::getKey() — Method in class Item
{@inheritdoc}
Item::get() — Method in class Item
{@inheritdoc}
MemoryCacheItemPool::getItem() — Method in class MemoryCacheItemPool
{@inheritdoc}
MemoryCacheItemPool::getItems() — Method in class MemoryCacheItemPool
{@inheritdoc}
SysVCacheItemPool::getItem() — Method in class SysVCacheItemPool
SysVCacheItemPool::getItems() — Method in class SysVCacheItemPool
TypedItem::getKey() — Method in class TypedItem
{@inheritdoc}
TypedItem::get() — Method in class TypedItem
{@inheritdoc}
AwsNativeSource::getImdsV2SessionToken() — Method in class AwsNativeSource
AwsNativeSource::getSignedRequestHeaders() — Method in class AwsNativeSource
AwsNativeSource::getRegionFromEnv() — Method in class AwsNativeSource
AwsNativeSource::getRegionFromUrl() — Method in class AwsNativeSource
AwsNativeSource::getRoleName() — Method in class AwsNativeSource
AwsNativeSource::getSigningVarsFromUrl() — Method in class AwsNativeSource
AwsNativeSource::getSigningVarsFromEnv() — Method in class AwsNativeSource
CredentialsLoader::getDefaultClientCertSource() — Method in class CredentialsLoader

Gets a callable which returns the default device certification.

CredentialsLoader::getUniverseDomain() — Method in class CredentialsLoader

Get the universe domain from the credential. Defaults to "googleapis.com" for all credential types which do not support universe domain.

AppIdentityCredentials::getProjectId() — Method in class AppIdentityCredentials

Get the project ID from AppIdentityService.

AppIdentityCredentials::getClientName() — Method in class AppIdentityCredentials

Get the client name from AppIdentityService.

AppIdentityCredentials::getLastReceivedToken() — Method in class AppIdentityCredentials
AppIdentityCredentials::getCacheKey() — Method in class AppIdentityCredentials

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

ExternalAccountCredentials::getCacheKey() — Method in class ExternalAccountCredentials

Obtains a key that can used to cache the results of #fetchAuthToken.

ExternalAccountCredentials::getLastReceivedToken() — Method in class ExternalAccountCredentials

Returns an associative array with the token and expiration time.

ExternalAccountCredentials::getQuotaProject() — Method in class ExternalAccountCredentials

Get the quota project used for this API request

GCECredentialsClass in namespace Google\Auth\Credentials

GCECredentials supports authorization on Google Compute Engine.

GCECredentials::getTokenUri() — Method in class GCECredentials

The full uri for accessing the default token.

GCECredentials::getClientNameUri() — Method in class GCECredentials

The full uri for accessing the default service account.

GCECredentials::getCacheKey() — Method in class GCECredentials
GCECredentials::getLastReceivedToken() — Method in class GCECredentials
GCECredentials::getClientName() — Method in class GCECredentials

Get the client name from GCE metadata.

GCECredentials::getProjectId() — Method in class GCECredentials

Fetch the default Project ID from compute engine.

GCECredentials::getQuotaProject() — Method in class GCECredentials

Get the quota project used for this API request

IAMCredentials::getUpdateMetadataFunc() — Method in class IAMCredentials

export a callback function which updates runtime metadata.

ImpersonatedServiceAccountCredentials::getClientName() — Method in class ImpersonatedServiceAccountCredentials

Get the client name from the keyfile

ImpersonatedServiceAccountCredentials::getCacheKey() — Method in class ImpersonatedServiceAccountCredentials
ImpersonatedServiceAccountCredentials::getLastReceivedToken() — Method in class ImpersonatedServiceAccountCredentials
InsecureCredentials::getCacheKey() — Method in class InsecureCredentials

Returns the cache key. In this case it returns a null value, disabling caching.

InsecureCredentials::getLastReceivedToken() — Method in class InsecureCredentials

Fetches the last received token. In this case, it returns the same empty string auth token.

ServiceAccountCredentials::getCacheKey() — Method in class ServiceAccountCredentials
ServiceAccountCredentials::getLastReceivedToken() — Method in class ServiceAccountCredentials
ServiceAccountCredentials::getProjectId() — Method in class ServiceAccountCredentials

Get the project ID from the service account keyfile.

ServiceAccountCredentials::getClientName() — Method in class ServiceAccountCredentials

Get the client name from the keyfile.

ServiceAccountCredentials::getQuotaProject() — Method in class ServiceAccountCredentials

Get the quota project used for this API request

ServiceAccountCredentials::getUniverseDomain() — Method in class ServiceAccountCredentials

Get the universe domain configured in the JSON credential.

ServiceAccountJwtAccessCredentials::getCacheKey() — Method in class ServiceAccountJwtAccessCredentials
ServiceAccountJwtAccessCredentials::getLastReceivedToken() — Method in class ServiceAccountJwtAccessCredentials
ServiceAccountJwtAccessCredentials::getProjectId() — Method in class ServiceAccountJwtAccessCredentials

Get the project ID from the service account keyfile.

ServiceAccountJwtAccessCredentials::getClientName() — Method in class ServiceAccountJwtAccessCredentials

Get the client name from the keyfile.

ServiceAccountJwtAccessCredentials::getQuotaProject() — Method in class ServiceAccountJwtAccessCredentials

Get the quota project used for this API request

UserRefreshCredentials::getCacheKey() — Method in class UserRefreshCredentials
UserRefreshCredentials::getLastReceivedToken() — Method in class UserRefreshCredentials
UserRefreshCredentials::getQuotaProject() — Method in class UserRefreshCredentials

Get the quota project used for this API request

UserRefreshCredentials::getGrantedScope() — Method in class UserRefreshCredentials

Get the granted scopes (if they exist) for the last fetched token.

FetchAuthTokenCache::getFetcher() — Method in class FetchAuthTokenCache
FetchAuthTokenCache::getCacheKey() — Method in class FetchAuthTokenCache
FetchAuthTokenCache::getLastReceivedToken() — Method in class FetchAuthTokenCache
FetchAuthTokenCache::getClientName() — Method in class FetchAuthTokenCache

Get the client name from the fetcher.

FetchAuthTokenCache::getQuotaProject() — Method in class FetchAuthTokenCache

Get the quota project used for this API request from the credentials fetcher.

FetchAuthTokenCache::getProjectId() — Method in class FetchAuthTokenCache

Get the project ID.

FetchAuthTokenCache::getUniverseDomain() — Method in class FetchAuthTokenCache

Get the universe domain from the credential. This should always return a string, and default to "googleapis.com" if no universe domain is configured.

FetchAuthTokenInterface::getCacheKey() — Method in class FetchAuthTokenInterface

Obtains a key that can used to cache the results of #fetchAuthToken.

FetchAuthTokenInterface::getLastReceivedToken() — Method in class FetchAuthTokenInterface

Returns an associative array with the token and expiration time.

GCECacheClass in namespace Google\Auth

A class to implement caching for calls to GCECredentials::onGce. This class is used automatically when you pass a Psr\Cache\CacheItemPoolInterface cache object to ApplicationDefaultCredentials::getCredentials.

GetQuotaProjectInterfaceClass in namespace Google\Auth

An interface implemented by objects that can get quota projects.

GetQuotaProjectInterface::getQuotaProject() — Method in class GetQuotaProjectInterface

Get the quota project used for this API request

GetUniverseDomainInterfaceClass in namespace Google\Auth

An interface implemented by objects that can get universe domain for Google Cloud APIs.

GetUniverseDomainInterface::getUniverseDomain() — Method in class GetUniverseDomainInterface

Get the universe domain from the credential. This should always return a string, and default to "googleapis.com" if no universe domain is configured.

Guzzle6HttpHandlerClass in namespace Google\Auth\HttpHandler
Guzzle7HttpHandlerClass in namespace Google\Auth\HttpHandler
HttpClientCache::getHttpClient() — Method in class HttpClientCache

Get the stored HTTP Client, or null.

OAuth2::generateCredentialsRequest() — Method in class OAuth2

Generates a request for token credentials.

OAuth2::getCacheKey() — Method in class OAuth2

Obtains a key that can used to cache the results of #fetchAuthToken.

OAuth2::getCodeVerifier() — Method in class OAuth2
OAuth2::generateCodeVerifier() — Method in class OAuth2

Generates a random 128-character string for the "code_verifier" parameter in PKCE for OAuth 2.0. This is a cryptographically random string that is determined using random_int, hashed using "hash" and sha256, and base64 encoded.

OAuth2::getAuthorizationUri() — Method in class OAuth2

Gets the authorization server's HTTP endpoint capable of authenticating the end-user and obtaining authorization.

OAuth2::getTokenCredentialUri() — Method in class OAuth2

Gets the authorization server's HTTP endpoint capable of issuing tokens and refreshing expired tokens.

OAuth2::getRedirectUri() — Method in class OAuth2

Gets the redirection URI used in the initial request.

OAuth2::getScope() — Method in class OAuth2

Gets the scope of the access requests as a space-delimited String.

OAuth2::getGrantType() — Method in class OAuth2

Gets the current grant type.

OAuth2::getState() — Method in class OAuth2

Gets an arbitrary string designed to allow the client to maintain state.

OAuth2::getCode() — Method in class OAuth2

Gets the authorization code issued to this client.

OAuth2::getUsername() — Method in class OAuth2

Gets the resource owner's username.

OAuth2::getPassword() — Method in class OAuth2

Gets the resource owner's password.

OAuth2::getClientId() — Method in class OAuth2

Sets a unique identifier issued to the client to identify itself to the authorization server.

OAuth2::getClientSecret() — Method in class OAuth2

Gets a shared symmetric secret issued by the authorization server, which is used to authenticate the client.

OAuth2::getIssuer() — Method in class OAuth2

Gets the Issuer ID when using assertion profile.

OAuth2::getSub() — Method in class OAuth2

Gets the target sub when issuing assertions.

OAuth2::getAudience() — Method in class OAuth2

Gets the target audience when issuing assertions.

OAuth2::getSigningKey() — Method in class OAuth2

Gets the signing key when using an assertion profile.

OAuth2::getSigningKeyId() — Method in class OAuth2

Gets the signing key id when using an assertion profile.

OAuth2::getSigningAlgorithm() — Method in class OAuth2

Gets the signing algorithm when using an assertion profile.

OAuth2::getExtensionParams() — Method in class OAuth2

Gets the set of parameters used by extension when using an extension grant type.

OAuth2::getExpiry() — Method in class OAuth2

Gets the number of seconds assertions are valid for.

OAuth2::getExpiresIn() — Method in class OAuth2

Gets the lifetime of the access token in seconds.

OAuth2::getExpiresAt() — Method in class OAuth2

Gets the time the current access token expires at.

OAuth2::getIssuedAt() — Method in class OAuth2

Gets the time the current access token was issued at.

OAuth2::getAccessToken() — Method in class OAuth2

Gets the current access token.

OAuth2::getIdToken() — Method in class OAuth2

Gets the current ID token.

OAuth2::getGrantedScope() — Method in class OAuth2

Get the granted space-separated scopes (if they exist) for the last fetched token.

OAuth2::getRefreshToken() — Method in class OAuth2

Gets the refresh token associated with the current access token.

OAuth2::getAdditionalClaims() — Method in class OAuth2

Gets the additional claims to be included in the JWT token.

OAuth2::getIssuedTokenType() — Method in class OAuth2

Gets the additional claims to be included in the JWT token.

OAuth2::getLastReceivedToken() — Method in class OAuth2

The expiration of the last received token.

ProjectIdProviderInterface::getProjectId() — Method in class ProjectIdProviderInterface

Get the project ID.

SignBlobInterface::getClientName() — Method in class SignBlobInterface

Returns the current Client Name.

UpdateMetadataTrait::getUpdateMetadataFunc() — Method in class UpdateMetadataTrait

export a callback function which updates runtime metadata.

H

MemoryCacheItemPool::hasItem() — Method in class MemoryCacheItemPool
{@inheritdoc}
SysVCacheItemPool::hasItem() — Method in class SysVCacheItemPool
{@inheritdoc}
HttpClientCacheClass in namespace Google\Auth\HttpHandler

Stores an HTTP Client in order to prevent multiple instantiations.

HttpHandlerFactoryClass in namespace Google\Auth\HttpHandler

I

InvalidArgumentExceptionClass in namespace Google\Auth\Cache
ItemClass in namespace Google\Auth\Cache

A cache item.

Item::isHit() — Method in class Item
{@inheritdoc}
TypedItem::isHit() — Method in class TypedItem
{@inheritdoc}
IAMCredentialsClass in namespace Google\Auth\Credentials

Authenticates requests using IAM credentials.

ImpersonatedServiceAccountCredentialsClass in namespace Google\Auth\Credentials
$ ImpersonatedServiceAccountCredentials#impersonatedServiceAccountNameProperty in class ImpersonatedServiceAccountCredentials
InsecureCredentialsClass in namespace Google\Auth\Credentials

Provides a set of credentials that will always return an empty access token.

IamClass in namespace Google\Auth

Tools for using the IAM API.

IamSignerTraitClass in namespace Google\Auth
OAuth2::isExpired() — Method in class OAuth2

Returns true if the acccess token has expired.

K

$ OAuth2#knownSigningAlgorithmsProperty in class OAuth2

TODO: determine known methods from the keys of JWT::methods.

$ OAuth2#knownGrantTypesProperty in class OAuth2

The well known grant types.

L

$ AppIdentityCredentials#lastReceivedTokenProperty in class AppIdentityCredentials

Result of fetchAuthToken.

$ GCECredentials#lastReceivedTokenProperty in class GCECredentials

Result of fetchAuthToken.

M

MemoryCacheItemPoolClass in namespace Google\Auth\Cache

Simple in-memory cache implementation.

CredentialsLoader::makeCredentials() — Method in class CredentialsLoader

Create a new Credentials instance.

CredentialsLoader::makeHttpClient() — Method in class CredentialsLoader

Create an authorized HTTP Client from an instance of FetchAuthTokenInterface.

CredentialsLoader::makeInsecureCredentials() — Method in class CredentialsLoader

Create a new instance of InsecureCredentials.

O

AppIdentityCredentials::onAppEngine() — Method in class AppIdentityCredentials

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

GCECredentials::onAppEngineFlexible() — Method in class GCECredentials

Determines if this an App Engine Flexible instance, by accessing the GAE_INSTANCE environment variable.

GCECredentials::onGce() — Method in class GCECredentials

Determines if this a GCE instance, by accessing the expected metadata host.

GCECache::onGce() — Method in class GCECache

Caches the result of onGce so the metadata server is not called multiple times.

OAuth2Class in namespace Google\Auth

OAuth2 supports authentication by OAuth2 2-legged flows.

P

$ ServiceAccountCredentials#projectIdProperty in class ServiceAccountCredentials
$ ServiceAccountJwtAccessCredentials#projectIdProperty in class ServiceAccountJwtAccessCredentials
ProxyAuthTokenMiddlewareClass in namespace Google\Auth\Middleware

ProxyAuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header provided by an object implementing FetchAuthTokenInterface.

OAuth2::parseTokenResponse() — Method in class OAuth2

Parses the fetched tokens.

ProjectIdProviderInterfaceClass in namespace Google\Auth

Describes a Credentials object which supports fetching the project ID.

Q

CredentialsLoader::quotaProjectFromEnv() — Method in class CredentialsLoader

Fetch a quota project from the environment variable GOOGLE_CLOUD_QUOTA_PROJECT. Return null if GOOGLE_CLOUD_QUOTA_PROJECT is not specified.

$ ServiceAccountCredentials#quotaProjectProperty in class ServiceAccountCredentials

The quota project associated with the JSON credentials

$ ServiceAccountJwtAccessCredentials#quotaProjectProperty in class ServiceAccountJwtAccessCredentials

The quota project associated with the JSON credentials

$ UserRefreshCredentials#quotaProjectProperty in class UserRefreshCredentials

The quota project associated with the JSON credentials

R

AccessToken::revoke() — Method in class AccessToken

Revoke an OAuth2 access token or refresh token. This method will revoke the current access token, if a token isn't provided.

S

Item::set() — Method in class Item
{@inheritdoc}
MemoryCacheItemPool::save() — Method in class MemoryCacheItemPool
{@inheritdoc}
MemoryCacheItemPool::saveDeferred() — Method in class MemoryCacheItemPool
{@inheritdoc}
SysVCacheItemPoolClass in namespace Google\Auth\Cache

SystemV shared memory based CacheItemPool implementation.

SysVCacheItemPool::save() — Method in class SysVCacheItemPool
{@inheritdoc}
SysVCacheItemPool::saveDeferred() — Method in class SysVCacheItemPool
{@inheritdoc}
TypedItem::set() — Method in class TypedItem
{@inheritdoc}
CredentialsLoader::shouldLoadClientCertSource() — Method in class CredentialsLoader

Determines whether or not the default device certificate should be loaded.

AppIdentityCredentials::signBlob() — Method in class AppIdentityCredentials

Sign a string using AppIdentityService.

GCECredentials::setIsOnGce() — Method in class GCECredentials

Set whether or not we've already checked the GCE environment.

$ ImpersonatedServiceAccountCredentials#sourceCredentialsProperty in class ImpersonatedServiceAccountCredentials
ServiceAccountCredentialsClass in namespace Google\Auth\Credentials

ServiceAccountCredentials supports authorization using a Google service account.

ServiceAccountCredentials::setSub() — Method in class ServiceAccountCredentials
ServiceAccountJwtAccessCredentialsClass in namespace Google\Auth\Credentials

Authenticates requests using Google's Service Account credentials via JWT Access.

FetchAuthTokenCache::signBlob() — Method in class FetchAuthTokenCache

Sign a blob using the fetcher.

HttpClientCache::setHttpClient() — Method in class HttpClientCache

Cache an HTTP Client for later calls.

Iam::signBlob() — Method in class Iam

Sign a string using the IAM signBlob API.

IamSignerTrait::signBlob() — Method in class IamSignerTrait

Sign a string using the default service account private key.

ScopedAccessTokenMiddlewareClass in namespace Google\Auth\Middleware

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

SimpleMiddlewareClass in namespace Google\Auth\Middleware

SimpleMiddleware is a Guzzle Middleware that implements Google's Simple API access.

OAuth2::setCodeVerifier() — Method in class OAuth2

A cryptographically random string that is used to correlate the authorization request to the token request.

OAuth2::setAuthorizationUri() — Method in class OAuth2

Sets the authorization server's HTTP endpoint capable of authenticating the end-user and obtaining authorization.

OAuth2::setTokenCredentialUri() — Method in class OAuth2

Sets the authorization server's HTTP endpoint capable of issuing tokens and refreshing expired tokens.

OAuth2::setRedirectUri() — Method in class OAuth2

Sets the redirection URI used in the initial request.

OAuth2::setScope() — Method in class OAuth2

Sets the scope of the access request, expressed either as an Array or as a space-delimited String.

OAuth2::setGrantType() — Method in class OAuth2

Sets the current grant type.

OAuth2::setState() — Method in class OAuth2

Sets an arbitrary string designed to allow the client to maintain state.

OAuth2::setCode() — Method in class OAuth2

Sets the authorization code issued to this client.

OAuth2::setUsername() — Method in class OAuth2

Sets the resource owner's username.

OAuth2::setPassword() — Method in class OAuth2

Sets the resource owner's password.

OAuth2::setClientId() — Method in class OAuth2

Sets a unique identifier issued to the client to identify itself to the authorization server.

OAuth2::setClientSecret() — Method in class OAuth2

Sets a shared symmetric secret issued by the authorization server, which is used to authenticate the client.

OAuth2::setIssuer() — Method in class OAuth2

Sets the Issuer ID when using assertion profile.

OAuth2::setSub() — Method in class OAuth2

Sets the target sub when issuing assertions.

OAuth2::setAudience() — Method in class OAuth2

Sets the target audience when issuing assertions.

OAuth2::setSigningKey() — Method in class OAuth2

Sets the signing key when using an assertion profile.

OAuth2::setSigningKeyId() — Method in class OAuth2

Sets the signing key id when using an assertion profile.

OAuth2::setSigningAlgorithm() — Method in class OAuth2

Sets the signing algorithm when using an assertion profile.

OAuth2::setExtensionParams() — Method in class OAuth2

Sets the set of parameters used by extension when using an extension grant type.

OAuth2::setExpiry() — Method in class OAuth2

Sets the number of seconds assertions are valid for.

OAuth2::setExpiresIn() — Method in class OAuth2

Sets the lifetime of the access token in seconds.

OAuth2::setExpiresAt() — Method in class OAuth2

Sets the time the current access token expires at.

OAuth2::setIssuedAt() — Method in class OAuth2

Sets the time the current access token was issued at.

OAuth2::setAccessToken() — Method in class OAuth2

Sets the current access token.

OAuth2::setIdToken() — Method in class OAuth2

Sets the current ID token.

OAuth2::setGrantedScope() — Method in class OAuth2

Sets the current ID token.

OAuth2::setRefreshToken() — Method in class OAuth2

Sets the refresh token associated with the current access token.

OAuth2::setAdditionalClaims() — Method in class OAuth2

Sets additional claims to be included in the JWT token

ServiceAccountSignerTraitClass in namespace Google\Auth

Sign a string using a Service Account private key.

ServiceAccountSignerTrait::signBlob() — Method in class ServiceAccountSignerTrait

Sign a string using the service account private key.

SignBlobInterfaceClass in namespace Google\Auth

Describes a class which supports signing arbitrary strings.

SignBlobInterface::signBlob() — Method in class SignBlobInterface

Sign a string using the method which is best for a given credentials type.

T

TypedItemClass in namespace Google\Auth\Cache

A cache item.

OAuth2::toJwt() — Method in class OAuth2

Obtains the encoded jwt from the instance data.

U

UrlSourceClass in namespace Google\Auth\CredentialSource

Retrieve a token from a URL.

IAMCredentials::updateMetadata() — Method in class IAMCredentials

Updates metadata with the appropriate header metadata.

ServiceAccountCredentials::useJwtAccessWithScope() — Method in class ServiceAccountCredentials

When called, the ServiceAccountCredentials will use an instance of ServiceAccountJwtAccessCredentials to fetch (self-sign) an access token even when only scopes are supplied. Otherwise, ServiceAccountJwtAccessCredentials is only called when no scopes and an authUrl (audience) is suppled.

ServiceAccountCredentials::updateMetadata() — Method in class ServiceAccountCredentials

Updates metadata with the authorization token.

ServiceAccountJwtAccessCredentials::updateMetadata() — Method in class ServiceAccountJwtAccessCredentials

Updates metadata with the authorization token.

UserRefreshCredentialsClass in namespace Google\Auth\Credentials

Authenticates requests using User Refresh credentials.

FetchAuthTokenCache::updateMetadata() — Method in class FetchAuthTokenCache

Updates metadata with the authorization token.

OAuth2::updateToken() — Method in class OAuth2

Updates an OAuth 2.0 client.

UpdateMetadataInterfaceClass in namespace Google\Auth

Describes a Credentials object which supports updating request metadata (request headers).

UpdateMetadataInterface::updateMetadata() — Method in class UpdateMetadataInterface

Updates metadata with the authorization token.

UpdateMetadataTraitClass in namespace Google\Auth

Provides shared methods for updating request metadata (request headers).

UpdateMetadataTrait::updateMetadata() — Method in class UpdateMetadataTrait

Updates metadata with the authorization token.

V

AccessToken::verify() — Method in class AccessToken

Verifies an id token and returns the authenticated apiLoginTicket.

OAuth2::verifyIdToken() — Method in class OAuth2

Verifies the idToken if present.

_

AccessToken::__construct() — Method in class AccessToken
Item::__construct() — Method in class Item
SysVCacheItemPool::__construct() — Method in class SysVCacheItemPool

Create a SystemV shared memory based CacheItemPool.

TypedItem::__construct() — Method in class TypedItem
AwsNativeSource::__construct() — Method in class AwsNativeSource
FileSource::__construct() — Method in class FileSource
UrlSource::__construct() — Method in class UrlSource
AppIdentityCredentials::__construct() — Method in class AppIdentityCredentials
ExternalAccountCredentials::__construct() — Method in class ExternalAccountCredentials
GCECredentials::__construct() — Method in class GCECredentials
IAMCredentials::__construct() — Method in class IAMCredentials
ImpersonatedServiceAccountCredentials::__construct() — Method in class ImpersonatedServiceAccountCredentials

Instantiate an instance of ImpersonatedServiceAccountCredentials from a credentials file that has be created with the --impersonated-service-account flag.

ServiceAccountCredentials::__construct() — Method in class ServiceAccountCredentials

Create a new ServiceAccountCredentials.

ServiceAccountJwtAccessCredentials::__construct() — Method in class ServiceAccountJwtAccessCredentials

Create a new ServiceAccountJwtAccessCredentials.

UserRefreshCredentials::__construct() — Method in class UserRefreshCredentials

Create a new UserRefreshCredentials.

FetchAuthTokenCache::__construct() — Method in class FetchAuthTokenCache
GCECache::__construct() — Method in class GCECache
Guzzle6HttpHandler::__construct() — Method in class Guzzle6HttpHandler
Guzzle6HttpHandler::__invoke() — Method in class Guzzle6HttpHandler

Accepts a PSR-7 request and an array of options and returns a PSR-7 response.

Iam::__construct() — Method in class Iam
AuthTokenMiddleware::__construct() — Method in class AuthTokenMiddleware

Creates a new AuthTokenMiddleware.

AuthTokenMiddleware::__invoke() — Method in class AuthTokenMiddleware

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

ProxyAuthTokenMiddleware::__construct() — Method in class ProxyAuthTokenMiddleware

Creates a new ProxyAuthTokenMiddleware.

ProxyAuthTokenMiddleware::__invoke() — Method in class ProxyAuthTokenMiddleware

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

ScopedAccessTokenMiddleware::__construct() — Method in class ScopedAccessTokenMiddleware

Creates a new ScopedAccessTokenMiddleware.

ScopedAccessTokenMiddleware::__invoke() — Method in class ScopedAccessTokenMiddleware

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

SimpleMiddleware::__construct() — Method in class SimpleMiddleware

Create a new Simple plugin.

SimpleMiddleware::__invoke() — Method in class SimpleMiddleware

Updates the request query with the developer key if auth is set to simple.

OAuth2::__construct() — Method in class OAuth2

Create a new OAuthCredentials.