Acclaim OAuth2 Provider for Laravel Socialite

4.1.0 2020-12-01 23:10 UTC

This package is auto-updated.

Last update: 2024-07-01 00:13:51 UTC


README

Acclaim

composer require socialiteproviders/acclaim

Installation & Basic Usage

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

Add configuration to config/services.php

'acclaim' => [
    'client_id' => env('ACCLAIM_KEY'),
    'client_secret' => env('ACCLAIM_SECRET'),
    'redirect' => env('ACCLAIM_REDIRECT_URI')
],

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('acclaim', \SocialiteProviders\Acclaim\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\Acclaim\AcclaimExtendSocialite::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('acclaim')->redirect();

Returned User fields

  • id
  • nickname
  • name (same as nickname)
  • email
  • avatar

Reference