socialiteproviders/clerk

Clerk OAuth2 Provider for Laravel Socialite

5.0.0 2024-02-19 12:17 UTC

Requires

• php: ^8.0
• ext-json: *
• socialiteproviders/manager: ^4.4

MIT

• Ignacio Cano

• oauth
• provider
• laravel
• socialite
• clerk

README

This is a provider for Clerk

composer require socialiteproviders/clerk

Installation & Basic Usage

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

Add configuration to config/services.php

'clerk' => [
  'client_id' => env('CLERK_CLIENT_ID'),
  'client_secret' => env('CLERK_CLIENT_SECRET'),
  'redirect' => env('CLERK_CALLBACK_URL'),
  'base_url' => env('CLERK_BASE_URL'),
],

Add base URL to .env

Clerk provides a customer URL for your different projects. For this reason you need to provide a base_url.

CLERK_BASE_URL=https://example.clerk.accounts.dev

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('clerk', \SocialiteProviders\Clerk\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
        \SocialiteProviders\Clerk\ClerkExtendSocialite::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('clerk')->redirect();

Returned User fields

• id
• nickname
• name
• email
• avatar