Reference documentation and code samples for the Google Auth Library Client class FetchAuthTokenInterface.
An interface implemented by objects that can fetch auth tokens.
Classes which implement this interface in this package:
- CredentialsLoader
- Credentials\ExternalAccountCredentials
- Credentials\GCECredentials
- Credentials\ImpersonatedServiceAccountCredentials
- Credentials\InsecureCredentials
- Credentials\ServiceAccountCredentials
- Credentials\ServiceAccountJwtAccessCredentials
- Credentials\UserRefreshCredentials
- FetchAuthTokenCache
- OAuth2
Namespace
Google \ AuthMethods
fetchAuthToken
Fetches the auth tokens based on the current state.
Parameter
Name
Description
httpHandler
callable|null
callback which delivers psr7 request
Returns
Type
Description
array
a hash of auth tokens
getCacheKey
Obtains a key that can used to cache the results of #fetchAuthToken.
If the value is empty, the auth token is not cached.
Returns
Type
Description
string
a key that may be used to cache the auth token.
getLastReceivedToken
Returns an associative array with the token and expiration time.
Returns
Type
Description
null|array
{
The last received access token.
@type string $access_token The access token string.
@type int $expires_at The time the token expires as a UNIX timestamp.
}
