# 1. Installation
You'll need to install the provider(s) you wish to use via composer, for example:
composer require socialiteproviders/zoho
# 2. Service Provider
Remove
Laravel\Socialite\SocialiteServiceProvider
from yourproviders[]
array inconfig\app.php
if you have added it already.Add
\SocialiteProviders\Manager\ServiceProvider::class
to yourproviders[]
array inconfig\app.php
.
For example:
'providers' => [
// a whole bunch of providers
// remove 'Laravel\Socialite\SocialiteServiceProvider',
\SocialiteProviders\Manager\ServiceProvider::class, // add
];
- Note: If you would like to use the Socialite Facade, you need to install the official package.
# 3. Event Listener
Add
SocialiteProviders\Manager\SocialiteWasCalled
event to yourlisten[]
array inapp/Providers/EventServiceProvider
.Add your listeners (i.e. the ones from the providers) to the
SocialiteProviders\Manager\SocialiteWasCalled[]
that you just created.Add the listener for your provider to the array. In our example, this is
'SocialiteProviders\\Zoho\\ZohoExtendSocialite@handle',
.Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.
For example with Zoho:
/**
* The event handler mappings for the application.
*
* @var array
*/
protected $listen = [
\SocialiteProviders\Manager\SocialiteWasCalled::class => [
// add your listeners (aka providers) here
'SocialiteProviders\\Zoho\\ZohoExtendSocialite@handle',
],
];
# Reference
# 4. Configuration setup
You will need to add an entry to the services configuration file so that after config files are cached for usage in production environment (Laravel command artisan config:cache
) all config is still available.
See your provider README for more infomation on the required config.
# 5. Usage
You should now be able to use it like you would regularly use Socialite (assuming you have the facade installed):
return Socialite::driver('zoho')->redirect();
# Lumen Support
You can use Socialite providers with Lumen. Just make sure that you have facade support turned on and that you follow the setup directions properly.
Note: If you are using this with Lumen, all providers will automatically be stateless since Lumen does not keep track of state.
Also, configs cannot be parsed from the services[]
in Lumen. You can only set the values in the .env
file as shown exactly in this document. If needed, you can
also override a config (shown below).
# Stateless
- You can set whether or not you want to use the provider as stateless. Remember that the OAuth provider (Twitter, Tumblr, etc) must support whatever option you choose.
Note: If you are using this with Lumen, all providers will automatically be stateless since Lumen does not keep track of state.
// to turn off stateless
return Socialite::driver('zoho')->stateless(false)->redirect();
// to use stateless
return Socialite::driver('zoho')->stateless()->redirect();
# Overriding a config
If you need to override the provider's environment or config variables dynamically anywhere in your application, you may use the following:
$clientId = "secret";
$clientSecret = "secret";
$redirectUrl = "http://yourdomain.com/api/redirect";
$additionalProviderConfig = ['site' => 'meta.stackoverflow.com'];
$config = new \SocialiteProviders\Manager\Config($clientId, $clientSecret, $redirectUrl, $additionalProviderConfig);
return Socialite::driver('zoho')->setConfig($config)->redirect();
# Retrieving the Access Token Response Body
Laravel Socialite by default only allows access to the access_token
. Which can be accessed
via the \Laravel\Socialite\User->token
public property. Sometimes you need access to the whole response body which
may contain items such as a refresh_token
.
You can get the access token response body, after you called the user()
method in Socialite, by accessing the property $user->accessTokenResponseBody
;
$user = Socialite::driver('zoho')->user();
$accessTokenResponseBody = $user->accessTokenResponseBody;