ORCID OAuth2 Provider for Laravel Socialite

5.0.1 2022-08-04 06:57 UTC

This package is auto-updated.

Last update: 2023-11-07 22:27:54 UTC


composer require socialiteproviders/orcid

Installation & Basic Usage

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

Add configuration to config/services.php

Please note, the latest version of this package requires you to use services config file. Previously enviroment variables were read directly, which is no longer supported

'orcid' => [    
  'client_id' => env('ORCID_CLIENT_ID'),  
  'client_secret' => env('ORCID_CLIENT_SECRET'),  
  'redirect' => env('ORCID_REDIRECT_URI') ,
  'environment' => env('ORCID_ENVIRONMENT'), // Optional
  'uid_fieldname' => env('ORCID_UID_FIELDNAME'), // Optional

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 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('orcid')->redirect();