Laravel Socialite

    Upgrading Socialite

    When upgrading to a new major version of Socialite, it’s important that you carefully review the upgrade guide.

    Installation

    To get started with Socialite, use Composer to add the package to your project’s dependencies:

    Before using Socialite, you will also need to add credentials for the OAuth services your application utilizes. These credentials should be placed in your configuration file, and should use the key facebook, twitter, linkedin, google, github, gitlab or bitbucket, depending on the providers your application requires. For example:

    1. 'github' => [
    2.     'client_id' => env('GITHUB_CLIENT_ID'),
    3.     'client_secret' => env('GITHUB_CLIENT_SECRET'),
    4.     'redirect' => 'http://your-callback-url',
    5. ],

    Routing

    1. <?php
    2. namespace App\Http\Controllers\Auth;
    4. use App\Http\Controllers\Controller;
    5. use Laravel\Socialite\Facades\Socialite;
    7. class LoginController extends Controller
    8. {
    9.     /**
    10.      * Redirect the user to the GitHub authentication page.
    11.      *
    13.      */
    14.     public function redirectToProvider()
    15.     {
    16.         return Socialite::driver('github')->redirect();
    17.     }
    19.     /**
    20.      * Obtain the user information from GitHub.
    21.      *
    22.      * @return \Illuminate\Http\Response
    23.      */
    24.     public function handleProviderCallback()
    25.     {
    26.         $user = Socialite::driver('github')->user();
    28.     }
    29. }

    The redirect method takes care of sending the user to the OAuth provider, while the user method will read the incoming request and retrieve the user’s information from the provider.

    You will need to define routes to your controller methods:

    Optional Parameters

    A number of OAuth providers support optional parameters in the redirect request. To include any optional parameters in the request, call the with method with an associative array:

    1. return Socialite::driver('google')
    2.     ->with(['hd' => 'example.com'])
    3.     ->redirect();

    Before redirecting the user, you may also add additional “scopes” on the request using the scopes method. This method will merge all existing scopes with the ones you supply:

    1. return Socialite::driver('github')
    2.     ->scopes(['read:user', 'public_repo'])
    3.     ->redirect();

    Stateless Authentication

    The stateless method may be used to disable session state verification. This is useful when adding social authentication to an API:

    1. return Socialite::driver('google')->stateless()->user();

    Retrieving User Details

    Once you have a user instance, you can grab a few more details about the user:

    1. $user = Socialite::driver('github')->user();
    3. // OAuth Two Providers
    4. $token = $user->token;
    5. $refreshToken = $user->refreshToken; // not always provided
    6. $expiresIn = $user->expiresIn;
    8. // OAuth One Providers
    9. $token = $user->token;
    10. $tokenSecret = $user->tokenSecret;
    12. // All Providers
    13. $user->getId();
    14. $user->getNickname();
    15. $user->getName();
    16. $user->getEmail();
    17. $user->getAvatar();

    Retrieving User Details From A Token (OAuth2)

    If you already have a valid access token for a user, you can retrieve their details using the userFromToken method:

    Retrieving User Details From A Token And Secret (OAuth1)

    If you already have a valid pair of token / secret for a user, you can retrieve their details using the userFromTokenAndSecret method: