Maintained By atymic

# Kanidm

composer require socialiteproviders/kanidm

# Installation & Basic Usage

Please see the Base Installation Guide (opens new window), then follow the provider specific instructions below.

# Add configuration to `config/services.php`

'kanidm' => [
  'client_id' => env('KANIDM_CLIENT_ID'),
  'client_secret' => env('KANIDM_CLIENT_SECRET'),
  'redirect' => env('KANIDM_REDIRECT_URI'),
  'base_url' => env('KANIDM_BASE_URL'),
],

# Add base URL to `.env`

Kanidm may require you to autorize against a custom URL, which you may provide as the base URL.

KANIDM_BASE_URL=https://idm.example.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('kanidm', \SocialiteProviders\Kanidm\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 (opens new window) for detailed instructions.

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Kanidm\KanidmExtendSocialite::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('kanidm')->redirect();

# Returned User fields

id
nickname
name
email

← Kakao Keycloak →