To get started with Socialite, use Composer to add the package to your project's dependencies:
composer require laravel/socialite
Configuration:
Before using Socialite, you will also need to add credentials for the OAuth services your application utilizes. These credentials should be placed in your config/services.php configuration file, and should use the key facebook, twitter, linkedin, google, github or bitbucket, depending on the providers your application requires. For example:
'github' => [
'client_id' => env('GITHUB_CLIENT_ID'), 'client_secret' => env('GITHUB_CLIENT_SECRET'), 'redirect' => 'http://your-callback-url',
],
Routing:
Next, you are ready to authenticate users! You will need two routes: one for redirecting the user to the OAuth provider, and another for receiving the callback from the provider after authentication. We will access Socialite using the Socialite facade:
<?php
namespace App\Http\Controllers\Auth;
use Socialite;
class LoginController extends Controller
{
public function redirectToProvider()
{
return Socialite::driver('github')->redirect();
}
public function handleProviderCallback()
{
$user = Socialite::driver('github')->user();
}
}
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.
Of course, you will need to define routes to your controller methods:
Route::get('login/github', 'Auth\LoginController@redirectToProvider');
Route::get('login/github/callback', 'Auth\LoginController@handleProviderCallback');
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:
return Socialite::driver('google')
->with(['hd' => 'example.com'])
->redirect();
Access Scopes
Before redirecting the user, you may also add additional "scopes" on the request using the scopesmethod. This method will merge all existing scopes with the ones you supply:
return Socialite::driver('github')
->scopes(['read:user', 'public_repo'])
->redirect();
You can overwrite all exisiting scopes using the setScopes method:
return Socialite::driver('github')
->setScopes(['read:user', 'public_repo'])
->redirect();
The stateless method may be used to disable session state verification. This is useful when adding social authentication to an API:
return Socialite::driver('google')->stateless()->user();
Once you have a user instance, you can grab a few more details about the user:
$user = Socialite::driver('github')->user();
$token = $user->token;
$refreshToken = $user->refreshToken;$expiresIn = $user->expiresIn;
$token = $user->token;
$tokenSecret = $user->tokenSecret;
$user->getId();
$user->getNickname();
$user->getName();
$user->getEmail();
$user->getAvatar();
Retrieving User Details From A Token
If you already have a valid access token for a user, you can retrieve their details using the userFromToken method:
$user = Socialite::driver('github')->userFromToken($token);