https://github.com/socialiteproviders/authentik
[READ ONLY] Subtree split of the SocialiteProviders/Authentik Provider (see SocialiteProviders/Providers)
https://github.com/socialiteproviders/authentik
laravel oauth oauth1 oauth2 social-media socialite socialite-providers
Last synced: about 2 months ago
JSON representation
[READ ONLY] Subtree split of the SocialiteProviders/Authentik Provider (see SocialiteProviders/Providers)
- Host: GitHub
- URL: https://github.com/socialiteproviders/authentik
- Owner: SocialiteProviders
- Created: 2022-08-04T08:06:35.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T21:59:26.000Z (11 months ago)
- Last Synced: 2025-07-25T04:50:17.253Z (3 months ago)
- Topics: laravel, oauth, oauth1, oauth2, social-media, socialite, socialite-providers
- Language: PHP
- Homepage: https://socialiteproviders.com/Authentik/
- Size: 10.7 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Authentik
```bash
composer require socialiteproviders/authentik
```
## Installation & Basic Usage
Please see the [Base Installation Guide](https://socialiteproviders.com/usage/),
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`
```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
#### 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.
```php
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
$event->extendSocialite('authentik', \SocialiteProviders\Authentik\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](https://socialiteproviders.com/usage/) for detailed instructions.
```php
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):
```php
return Socialite::driver('authentik')->redirect();
```
To redirect to the authentication, and then:
```php
$user = Socialite::driver('authentik')->user()
```
In the return function. The user will contain a `name` and `email` field
populated from the OAuth source.