Download the PHP package league/oauth2-google without Composer
On this page you can find all versions of the php package league/oauth2-google. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download league/oauth2-google
More information about league/oauth2-google
Files in league/oauth2-google
Package oauth2-google
Short Description Google OAuth 2.0 Client Provider for The PHP League OAuth2-Client
License MIT
Informations about the package oauth2-google
Google Provider for OAuth 2.0 Client
This package provides Google OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
This package is compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request.
Requirements
The following versions of PHP are supported.
- PHP 7.3
- PHP 7.4
- PHP 8.0
- PHP 8.1
- PHP 8.2
- PHP 8.3
This package uses OpenID Connect to authenticate users with Google accounts.
To use this package, it will be necessary to have a Google client ID and client
secret. These are referred to as {google-client-id}
and {google-client-secret}
in the documentation.
Please follow the Google instructions to create the required credentials.
Installation
To install, use composer:
Usage
Authorization Code Flow
Available Options
The Google
provider has the following options:
accessType
to use online or offline accesshostedDomain
to authenticate G Suite usersprompt
to modify the prompt that the user will seescopes
to request access to additional user information
Accessing Token JWT
Google provides a JSON Web Token (JWT) with all access tokens. This token
contains basic information about the authenticated user. The JWT
can be accessed from the id_token
value of the access token:
Parsing the JWT will require a JWT parser. Refer to parser documentation for instructions.
Refreshing a Token
Refresh tokens are only provided to applications which request offline access. You can specify offline access by setting the accessType
option in your provider:
It is important to note that the refresh token is only returned on the first request after this it will be null
. You should securely store the refresh token when it is returned:
If you ever need to get a new refresh token you can request one by forcing the consent prompt:
Now you have everything you need to refresh an access token using a refresh token:
Scopes
Additional scopes can be set by using the scope
parameter when
generating the authorization URL:
Testing
Tests can be run with:
Style checks can be run with:
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.