# Authentik
composer require socialiteproviders/authentik
# Installation & Basic Usage
Please see the Base Installation Guide (opens new window), then follow the provider specific instructions below.
# Prepare OAuth provider & application in Authentik
Create a new OAuth provider within Authentik, according to the Authentik Documentation (https://goauthentik.io/docs/providers/oauth2/)
# Add configuration to config/services.php
'authentik' => [
'base_url' => env('AUTHENTIK_BASE_URL'),
'client_id' => env('AUTHENTIK_CLIENT_ID'),
'client_secret' => env('AUTHENTIK_CLIENT_SECRET'),
'redirect' => env('AUTHENTIK_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 (opens new window) for
detailed instructions.
protected $listen = [
\SocialiteProviders\Manager\SocialiteWasCalled::class => [
// ... other providers
\SocialiteProviders\Authentik\AuthentikExtendSocialite::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('authentik')->redirect();
To redirect to the authentication, and then:
$user = Socialite::driver('authentik')->user()
In the return function. The user will contain a name
and email
field
populated from the OAuth source.