socialiteproviders/instructure

Instructure OAuth2 Provider for Laravel Socialite

5.0.0 2022-05-13 04:23 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• socialiteproviders/manager: ~4.0

MIT

• Frank Perez

• oauth
• provider
• laravel
• socialite
• instructure

README

composer require socialiteproviders/instructure

Installation & Basic Usage

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

Add configuration to config/services.php

'instructure' => [    
  'client_id' => env('INSTRUCTURE_CLIENT_ID'),  
  'client_secret' => env('INSTRUCTURE_CLIENT_SECRET'),  
  'redirect' => env('INSTRUCTURE_REDIRECT_URI'),
  'instance_url' => env('INSTRUCTURE_INSTANCE_URL')
],

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('instructure', \SocialiteProviders\Instructure\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\Instructure\InstructureExtendSocialite::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('instructure')->redirect();

Returned User fields

• id
• name
• email