GovBR OAuth2 Provider for Laravel Socialite

5.0.0 2023-02-28 22:03 UTC

This package is auto-updated.

Last update: 2024-07-02 00:17:23 UTC



composer require socialiteproviders/govbr

Installation & Basic Usage

Please see the Base Installation Guide, then follow the provider specific instructions below.

Add configuration to config/services.php

'govbr' => [
    'client_id' => env('GOVBR_CLIENT_ID'),
    'client_secret' => env('GOVBR_CLIENT_SECRET'),
    'redirect' => env('GOVBR_REDIRECT_URI'),
    'environment' => env('GOVBR_ENVIRONMENT', 'production'),

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('govbr', \SocialiteProviders\GovBR\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


You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

return Socialite::driver('govbr')->redirect();

Returned User fields

  • id
  • cpf
  • name
  • email
  • email_verified
  • phone_number
  • phone_number_verified
  • avatar_url
  • profile