SuperOffice OAuth2 Provider for Laravel Socialite

4.2.1 2023-04-29 00:31 UTC

This package is auto-updated.

Last update: 2024-05-02 00:01:48 UTC


composer require socialiteproviders/superoffice

Installation & Basic Usage

Please see the Base Installation Guide, then follow the provider specific instructions below.

Add configuration to config/services.php

'superoffice' => [    
  'client_id' => env('SUPEROFFICE_CLIENT_ID'),  
  'client_secret' => env('SUPEROFFICE_CLIENT_SECRET'),  
  'redirect' => env('SUPEROFFICE_REDIRECT_URI'),
  'environment' => env('SUPEROFFICE_ENVIRONMENT'), // can be sod, qaonline or online depending on your apps approval stage
  'customer_id' => env('SUPEROFFICE_CUSTOMER_ID') 

Add provider event listener

Laravel 11+

In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your AppServiceProvider boot method.

  • Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('superoffice', \SocialiteProviders\SuperOffice\Provider::class);
Laravel 10 or below Configure the package's listener to listen for `SocialiteWasCalled` events.

Add the event to your listen[] array in app/Providers/EventServiceProvider. See the Base Installation Guide for detailed instructions.

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers


You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

return Socialite::driver('superoffice')->redirect();

Returned user fields

  • id
  • name
  • email
  • username