Socialite Providers
Maintained By GitHub icon pfvatterott
GitHub icon Github Repo
|
Edit

# PropelAuth

This is a provider for PropelAuth (opens new window)

composer require socialiteproviders/propelauth

# Installation & Basic Usage

Please see the Base Installation Guide (opens new window), then follow the docs here (opens new window) on how to setup an OAuth provider in PropelAuth.

# Add configuration to config/services.php

'propelauth' => [
  'client_id' => env('PROPELAUTH_CLIENT_ID'),
  'client_secret' => env('PROPELAUTH_CLIENT_SECRET'),
  'redirect' => env('PROPELAUTH_CALLBACK_URL'),
  'auth_url' => env('PROPELAUTH_AUTH_URL'),
],

# Add Auth URL to .env

Get your Auth URL from PropelAuth in the Frontend Integration page. The PROPELAUTH_CALLBACK_URL value must be entered as a Redirect URI in PropelAuth.

PROPELAUTH_AUTH_URL=https://example.propelauth.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('propelauth', \SocialiteProviders\PropelAuth\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\PropelAuth\PropelAuthExtendSocialite::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('propelauth')->redirect();

# Returned User fields

  • id
  • email
  • first_name
  • last_name

# Additional PropelAuth Fields

If you need to access additional user fields, you can retrieve those from the raw user array:

$user = Socialite::driver('propelauth')->user();

$rawUser = $user->getRaw();

$orgs = $rawUser['org_id_to_org_info'];

← Pinterest →