socialiteproviders / auth0
Auth0 OAuth2 Provider for Laravel Socialite
4.2.0
2024-05-20 23:48 UTC
Requires
- php: ^8.0
- ext-json: *
- socialiteproviders/manager: ^4.4
This package is auto-updated.
Last update: 2024-11-07 21:59:30 UTC
README
composer require socialiteproviders/auth0
Installation & Basic Usage
Please see the Base Installation Guide, then follow the provider specific instructions below.
Add configuration to config/services.php
'auth0' => [ 'client_id' => env('AUTH0_CLIENT_ID'), 'client_secret' => env('AUTH0_CLIENT_SECRET'), 'redirect' => env('AUTH0_REDIRECT_URI'), 'base_url' => env('AUTH0_BASE_URL'), ],
Add base URL to .env
Auth0 may require you to autorize against a custom URL, which you may provide as the base URL.
AUTH0_BASE_URL=https://example.auth0.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('auth0', \SocialiteProviders\Auth0\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\Auth0\Auth0ExtendSocialite::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('auth0')->redirect();
Returned User fields
id
nickname
name
email