1. class
  2. Google
  3. \
  4. Auth
  5. \
  6. AccessToken

AccessToken

class AccessToken (View source)

Wrapper around Google Access Tokens which provides convenience functions.

Constants

FEDERATED_SIGNON_CERT_URL

IAP_CERT_URL

IAP_ISSUER

OAUTH2_ISSUER

OAUTH2_ISSUER_HTTPS

OAUTH2_REVOKE_URI

Methods

__construct(callable $httpHandler = null, CacheItemPoolInterface $cache = null)

No description

array|false
verify(string $token, array $options = [])

Verifies an id token and returns the authenticated apiLoginTicket.

bool
revoke(string|array $token, array $options = [])

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

mixed
callJwtStatic(string $method, array $args = [])

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

mixed
callSimpleJwtDecode(array $args = [])

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

Details

at line 71
__construct(callable $httpHandler = null, CacheItemPoolInterface $cache = null)

Parameters

callable $httpHandler [optional] An HTTP Handler to deliver PSR-7 requests.
CacheItemPoolInterface $cache [optional] A PSR-6 compatible cache implementation.

at line 110
array|false verify(string $token, array $options = [])

Verifies an id token and returns the authenticated apiLoginTicket.

Throws an exception if the id token is not valid. The audience parameter can be used to control which id tokens are accepted. By default, the id token must have been issued to this OAuth2 client.

Parameters

string $token The JSON Web Token to be verified.
array $options [optional] { Configuration options. @type string $audience The indended recipient of the token. @type string $issuer The intended issuer of the token. @type string $cacheKey The cache key of the cached certs. Defaults to the sha1 of $certsLocation if provided, otherwise is set to "federated_signon_certs_v3". @type string $certsLocation The location (remote or local) from which to retrieve certificates, if not cached. This value should only be provided in limited circumstances in which you are sure of the behavior. @type bool $throwException Whether the function should throw an exception if the verification fails. This is useful for determining the reason verification failed. }

Return Value

array|false the token payload, if successful, or false if not.

Exceptions

InvalidArgumentException If certs could not be retrieved from a local file.
InvalidArgumentException If received certs are in an invalid format.
InvalidArgumentException If the cert alg is not supported.
RuntimeException If certs could not be retrieved from a remote location.
UnexpectedValueException If the token issuer does not match.
UnexpectedValueException If the token audience does not match.

at line 275
bool revoke(string|array $token, array $options = [])

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

Parameters

string|array $token The token (access token or a refresh token) that should be revoked.
array $options [optional] Configuration options.

Return Value

bool Returns True if the revocation was successful, otherwise False.

at line 442
protected mixed callJwtStatic(string $method, array $args = [])

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

Parameters

string $method
array $args

Return Value

mixed

at line 453
protected mixed callSimpleJwtDecode(array $args = [])

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

Parameters

array $args

Return Value

mixed