socialiteproviders / zitadel
Zitadel OAuth2 Provider for Laravel Socialite
4.1.0
2024-08-26 06:14 UTC
Requires
- php: ^8.1
- ext-json: *
- socialiteproviders/manager: ^4.4
This package is auto-updated.
Last update: 2024-11-07 22:20:30 UTC
README
composer require socialiteproviders/zitadel
Installation & Basic Usage
Please see the Base Installation Guide, then follow the provider specific instructions below.
Add configuration to config/services.php
'zitadel' => [ 'client_id' => env('ZITADEL_CLIENT_ID'), 'client_secret' => env('ZITADEL_CLIENT_SECRET'), 'redirect' => env('ZITADEL_REDIRECT_URI'), 'base_url' => env('ZITADEL_BASE_URL'), 'organization_id' => env('ZITADEL_ORGANIZATION_ID'), // Optional 'project_id' => env('ZITADEL_PROJECT_ID'), // Optional 'post_logout_redirect_uri' => env('ZITADEL_POST_LOGOUT_REDIRECT_URI') // Optional ],
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('zitadel', \SocialiteProviders\Zitadel\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\Zitadel\ZitadelExtendSocialite::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('zitadel')->redirect();
Get Logout Url
$idToken = ...; // Retrieve ID token here return redirect()->away(Socialite::driver('zitadel')->getLogoutUrl($idToken));
Note
Passing the ID token is optional, but it is recommended to logout specific user session.