Implementing social account authentication is very popular these days. ⁤⁤It is easy and powerful method for user authentication, social account authentication takes less effort from user for registration or login on your system. ⁤⁤there is no need for the user to remember the username and password.

Laravel 11 Socialite -  Implementing LinkedIn Sign-In in Your Laravel Application

Table Of Content

1 Prerequisites

1.) PHP version of 8.2
2.) MySql
3.) LinkedIn Account

2 Introduction

In this article, I am going to show you how to implementation social account authentication to your Laravel application. We’ll be using Laravel external libraries such as Socialite and Breeze Package. Laravel provides a package to authenticate with OAuth providers using Laravel Socialite. Although, this package is not pre-installed in laravel.

Laravel Socialite supports authentication only for the following social account providers:
  • Facebook
  • Twitter
  • LinkedIn
  • Google
  • GitHub
  • GitLab
  • Bitbucket
  • Slack.

3 Create / Install a Laravel Project

3.1 Install Laravel Project

First, make sure your computer has a composer.
Use the following command to install new Laravel Project.

composer create-project laravel/laravel linkedin-auth-app

Then, navigate to your project directory:

cd linkedin-auth-app

3.2 Configure MySql Database

Upon logging in, the user's record will be stored in the database. This process involves accessing the .env file to input and define the database credentials.

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel11
DB_USERNAME=root
DB_PASSWORD=

4 Install Laravel Packages

We will use Laravel Breeze as an example of our existing authentication implementation.

4.1 Install Breeze Package

Use the following command to Install Laravel Breeze Package

composer require laravel/breeze --dev
After Composer has installed the Laravel Breeze package, you should run the breeze:install Artisan command. This command publishes the authentication views, routes, controllers, and other resources to your application.

php artisan breeze:install
 
php artisan migrate
npm install
npm run dev

4.2 Install Socialite Package

Use the following command to Install Laravel Socialite Package

composer require laravel/socialite

5 Create LinkedIn App

5.1 Login into LinkedIn Developer App

If you have LinkedIn Developer Account Go to https://developer.linkedin.com/, else you can easily create one directly from the LinkedIn Developer Account.

5.2 Create App

Click "Create App" button in the LinkedIn Developer Portal

LinkedIn Developer Account

Entering App information in the following Screen

LinkedIn Create App Page

App successfully created with given information's

5.3 App Dashboard

Go to Dashboard in LinkedIn Developer Portal and Select Created App

LinkedIn Dashboard

Go to "Auth" Tab and update "Authorized redirect URLs for your app" This is the URI that we will use to redirect user after they choose their LinkedIn account to login to our web. For example here I use http://127.0.0.1:8000/callback/linkedin for the callback URI.

LinkedIn App Client ID and Client Secret

Now you will receive a Client ID and Client Secret. copy these keys into your .env file.

6 Configure LinkedIn App Credentials

6.1 Add the LinkedIn API Credentials in .env

Insert the Client ID and Client Secret key and redirect URI into the .env file, Which we obtained from previous step LINKEDIN_CLIENT_ID and LINKEDIN_CLIENT_SECRET. Additionally, include a new key in the .env file called LINKEDIN_REDIRECT_URI and populate it with the callback URI used in the Linkedin API Console.

LINKEDIN_CLIENT_ID=Your Client ID
LINKEDIN_CLIENT_SECRET=Your Client Secret
LINKEDIN_REDIRECT_URI=http://127.0.0.1:8000/callback/linkedin

6.2 Add the LinkedIn API .env key in config/services.php

Open the config/services.php file and Insert the LinkedIn OAuth Credentials

<?php

return [

    // Other services ..
    
    'linkedin' => [
        'client_id' => env('LINKEDIN_CLIENT_ID'),
        'client_secret' => env('LINKEDIN_CLIENT_SECRET'),
        'redirect' => env('LINKEDIN_REDIRECT_URI'),
    ],
];
?>
    

6.3 Add New Column within the Users Table to Store linkedin_id

Create a Laravel Migration to Add a New Column within the Users Table to Store linkedin_id

php artisan make:migration add_linkedin_id_to_users

In the generated new migration file, update the up and down methods as described below:

database/migrations/2024_05_24_120820_add_linkedin_id_to_users.php


<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->string('linkedin_id')->after('password')->nullable()->unique();
        });
    }

    public function down()
    {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn('linkedin_id');
        });
    }
};

Use the following command to run the migration to update your database.

php artisan migrate

6.4 Update the User Model

In your User model , Include linkedin_id in the fillable array of the User Model.
app/Models/User.php

<?php
namespace App\Models;

// use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use HasFactory, Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name',
        'email',
        'password',
        'linkedin_id'
    ];

    /**
     * The attributes that should be hidden for serialization.
     *
     * @var array
     */
    protected $hidden = [
        'password',
        'remember_token',
    ];

    /**
     * Get the attributes that should be cast.
     *
     * @return array
     */
    protected function casts(): array
    {
        return [
            'email_verified_at' => 'datetime',
            'password' => 'hashed',
        ];
    }
}

?>

7 Create New Controller - LinkedinLoginController

Now create a controller "LinkedinSocialiteController" and add redirectToLinkedin() and handleLinkedinCallback() methods
Use the following artisan command to Create Controller.

php artisan make:controller LinkedinSocialiteController

app/Http/Controllers/LinkedinLoginController.php

<?php
namespace App\Http\Controllers\Auth;
use App\Http\Controllers\Controller;
use App\Models\User;
use Auth;
use Exception;
use Socialite;

class LinkedinSocialiteController extends Controller
{
    public function redirectToLinkedin()
    {
        // redirect user to "login with LinkedIn account" page
        return Socialite::driver('linkedin')----->redirect();
    }

    public function handleCallback()
    {
        try {
            // get user data from LinkedIn 
            $user = Socialite::driver('linkedin')->user();
            // find user in the database where the social id is the same with the id provided by LinkedIn 
            $finduser = User::where('linkedin_id', $user->id)->first();

            if ($finduser)  // if user found then do this
            {
                // Log the user in
                Auth::login($finduser);

                // redirect user to dashboard page
                return redirect('/dashboard');
            }
            else
            {
                // if user not found then this is the first time he/she try to login with LinkedIn account
                // create user data with their LinkedIn account data
                $newUser = User::create([
                    'name' => $user->name,
                    'email' => $user->email,
                    'linkedin_id' => $user->id,
                    'password' => bcrypt('my-linkedin'),  // fill password by whatever pattern you choose
                ]);

                Auth::login($newUser);

                return redirect('/dashboard');
            }

        }
        catch (Exception $e)
        {
            dd($e->getMessage());
        }
    }
}
?>

8 Define a Route for Socialite Login with LinkedIn

Define routes for the LinkedinSocialiteController in the web.php file
routes/web.php

Route::get('auth/linkedin', [LinkedinSocialiteController::class, 'redirectToLinkedin']);  // redirect to LinkedIn login
Route::get('callback/linkedin', [LinkedinSocialiteController::class, 'handleCallback']);    // callback route after LinkedIn account chosen

9 Update Login Blade File With LinkedIn Button

Create the Link in the login view to Show LinkedIn Sign-in Button
resources/views/auth/login.blade.php


<a href="{{ url('auth/linkedin') }}">
 <img src="images/linkedin_button.png">
</a>


10 Folder Structure

11 Run Laravel Server to Test the App

Use the following artisan command to Test the App.

php artisan serve

Visit the URL http://127.0.0.1:8000

12 Conclusion

That’s all we need to do.
Now the LinkedIn Sign-In Implementation completed in Laravel application with the help of Laravel Socialite and Breeze package.

Tags