flightsimcorp/fsidentity-socialite-provider

FSIdentity OAuth2 Provider for Laravel Socialite

v1.0.0 2023-12-03 03:21 UTC

Requires

• php: ^8.0
• ext-json: *
• socialiteproviders/manager: ^4.4

MIT

• oauth
• oauth2
• provider
• laravel
• socialite
• fsidentity

README

composer require flightsimcorp/fsidentity-socialite-provider

Installation & Basic Usage

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

Create an application

Create an application at https://fsidentity.com/clients/new

Its important that you verify the following OAuth Settings are configured for your FSIdentity application:

• Token Endpoint Authentication Method: Client Secret Basic Auth
• Grant Types: Authorization Code

Add configuration to config/services.php

'fsidentity' => [
  'client_id' => env('FSIDENTITY_CLIENT_ID'),
  'client_secret' => env('FSIDENTITY_CLIENT_SECRET'),
  'redirect' => env('FSIDENTITY_REDIRECT_URI'),
],

Add provider event listener

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\FSIdentity\FSIdentityExtendSocialite::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('fsidentity')->redirect();

To add scopes to your Authentication you can use the below:

return Socialite::driver('fsidentity')->scopes(['name', 'email'])->redirect();

To add required scopes (those the user cannot opt out from) to your Authentication you can use the below:

return Socialite::driver('fsidentity')->requiredScopes(['name', 'email'])->redirect();

Returned User fields

• id
• name
• email
• preferred_username
• avatar_url
• locale
• timezone