// This assumes that you have composer installed globally composer require socialiteproviders/jira
2. Service Provider
config\app.phpif you have added it already.
'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 it.
3. Event Listener
SocialiteProviders\Manager\SocialiteWasCalledevent to your
Add your listeners (i.e. the ones from the providers) to the
SocialiteProviders\Manager\SocialiteWasCalledthat you just created.
The listener that you add for this provider is
Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.
/** * The event handler mappings for the application. * * @var array */ protected $listen = [ \SocialiteProviders\Manager\SocialiteWasCalled::class => [ // add your listeners (aka providers) here 'SocialiteProviders\\Jira\\JiraExtendSocialite@handle', ], ];
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.
'jira' => [ 'client_id' => env('JIRA_KEY'), 'client_secret' => env('JIRA_SECRET'), 'redirect' => env('JIRA_REDIRECT_URI'), 'base_uri' => env('JIRA_BASE_URI'), // the jira path to the jira server 'cert_path' => env('JIRA_CERT_PATH', storage_path('app/keys/jira.pem')), // this is the default path 'site' => env('JIRA_SITE'), // optional 'user_details_url' => env('JIRA_USER_DETAILS_URL'), // optional ],
JIRA_KEY=OauthKey JIRA_SECRET=YourSecretKey JIRA_BASE_URI=https://thejiraserver.com JIRA_REDIRECT_URI=https://yourlocalserver.com/callback JIRA_CERT_PATH=storage/app/your/path/to/cert.pemn JIRA_SITE=https://thejiraserver.com JIRA_USER_DETAILS_URL=https://thejiraserver.com/user/details
You should now be able to use it like you would regularly use Socialite (assuming you have the facade installed):
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).
- 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.
// to turn off stateless return Socialite::with('Jira')->stateless(false)->redirect(); // to use stateless return Socialite::with('Jira')->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::with('Jira')->setConfig($config)->redirect();
Retrieving the Access Token Response Body
Laravel Socialite by default only allows access to the
access_token. Which can be accessed
\Laravel\Socialite\User->token public property. Sometimes you need access to the whole response body which
may contain items such as a
You can get the access token response body, after you called the
user() method in Socialite, by accessing the property
$user = Socialite::driver('Jira')->user(); $accessTokenResponseBody = $user->accessTokenResponseBody;