socialiteproviders/kinde

Kinde OAuth2 Provider for Laravel Socialite

4.0.0 2024-12-03 05:55 UTC

Requires

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

MIT

• Mikko Kutilainen

• oauth
• provider
• laravel
• socialite
• kinde

README

This is a provider for Kinde

composer require socialiteproviders/kinde

Installation & Basic Usage

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

Add configuration to config/services.php

'kinde' => [
  'domain' => env('KINDE_DOMAIN'),
  'client_id' => env('KINDE_CLIENT_ID'),
  'client_secret' => env('KINDE_CLIENT_SECRET'),
  'redirect' => env('KINDE_CALLBACK_URL'),
],

Add domain to .env

Kinde provides a customer URL for your different projects. For this reason you need to provide a domain.

KINDE_DOMAIN=https://example.kinde.com

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('kinde', \SocialiteProviders\Kinde\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\Kinde\KindeExtendSocialite::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('kinde')->redirect();

Returned User fields

• id
• nickname
• name
• email
• avatar

Kinde specific fields

If you need to access the org_code or permissions fields, you can retrieve those from the raw user array:

$user = Socialite::driver('kinde')->user();

$rawUser = $user->getRaw();

$orgCode = $rawUser['org_code'];
$permissions = $rawUser['permissions'];