SharePoint OAuth2 Provider for Laravel Socialite

5.0.0 2021-06-02 22:32 UTC

This package is auto-updated.

Last update: 2024-07-02 00:30:50 UTC


README

SharePoint

composer require socialiteproviders/sharepoint

Installation & Basic Usage

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

Add configuration to config/services.php

Please note, the latest version of this package requires you to use services config file. Previously enviroment variables were read directly, which is no longer supported

'sharepoint' => [    
  'client_id' => env('SHAREPOINT_CLIENT_ID'),  
  'client_secret' => env('SHAREPOINT_CLIENT_SECRET'),  
  'redirect' => env('SHAREPOINT_REDIRECT_URI'),
  'site_url' => env('SHAREPOINT_SITE_URL'), // Optional
],

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('sharepoint', \SocialiteProviders\SharePoint\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
        \SocialiteProviders\SharePoint\SharePointExtendSocialite::class.'@handle',
    ],
];

Usage

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

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

Returned User fields

  • id
  • nickname
  • name
  • email
  • avatar