Using the Laravel passport API authentication tutorial you will learn how to build a secure REST API authentication using Passport in Laravel 10 application. Here you will learn to how to create and secure your Laravel back-end API using Laravel passport.
Laravel Passport takes care of security and allows you to create Auth Token to provide authentication to users. To secure this application, we will install Laravel Passport and generate an access token for each user after authentication. This will allow such users to have access to some of the secured endpoints.
Build API Authentication using Laravel Passport
Use follow the following steps and build the rest API authentication using Laravel Passport in Laravel 10 application.
- Step 1: Install Laravel App
- Step 2: Setup Database Credentials
- Step 3: Install Laravel Passport
- Step 3: Configure Laravel Passport
- Step 4: Create Authentication Controller
- Step 5: Update APIs Routes for Laravel Passport
- Step 6: Test Laravel REST API with Postman
#1 Download Laravel App
First, you just need to download or install a fresh Laravel application using the following command.
composer create-project laravel/laravel laravel-passport-authNow go inside your app:
laravel-passport-auth#2 Setup Database Credentials
After that add your database credentials in the .env file such as database, username and password which is located in your project root directory.
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=#db_name
DB_USERNAME=#db_username
DB_PASSWORD=#db_password#3 Install Laravel Passport
Now we install the Laravel passport using the following command.
composer require laravel/passportOnce the installation is complete, we have got new migration file which will store clients and access tokens. So, run the following command to migrate your database.
php artisan migrateNext, to create the encryption keys needed to generate secured access tokens, run the command below:
php artisan passport:install#4 Configure Laravel Passport
After the installation process now we will configure the passport authentication process in our laravel application. So, add the Laravel\Passport\HasApiTokens trait to your App\Models\User model as shown here.
<?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;
// use Laravel\Sanctum\HasApiTokens; // comment this
use Laravel\Passport\HasApiTokens; // include this
class User extends Authenticatable
{
use HasApiTokens, HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'email',
'password',
];
/**
* The attributes that should be hidden for serialization.
*
* @var array<int, string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
}Next, open the app/Providers/AuthServiceProvider.php file and register the registerPolicies() method inside the boot() function, It will evoke the required routes.
<?php
namespace App\Providers;
// use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
use Laravel\Passport\Passport; // add this
class AuthServiceProvider extends ServiceProvider
{
/**
* The model to policy mappings for the application.
*
* @var array<class-string, class-string>
*/
protected $policies = [
'App\Models\Model' => 'App\Policies\ModelPolicy',
];
/**
* Register any authentication / authorization services.
*/
public function boot(): void
{
$this->registerPolicies();
Passport::ignoreRoutes();
}
}
Finally, for your application to be ready to use Passport’s TokenGuard to authenticate any incoming API requests, open the config/auth.php configuration file and set the driver option of the api authentication guard to passport.
<?php
return [
/*
|--------------------------------------------------------------------------
| Authentication Defaults
|--------------------------------------------------------------------------
|
| This option controls the default authentication "guard" and password
| reset options for your application. You may change these defaults
| as required, but they're a perfect start for most applications.
|
*/
'defaults' => [
'guard' => 'web',
'passwords' => 'users',
],
/*
|--------------------------------------------------------------------------
| Authentication Guards
|--------------------------------------------------------------------------
|
| Next, you may define every authentication guard for your application.
| Of course, a great default configuration has been defined for you
| here which uses session storage and the Eloquent user provider.
|
| All authentication drivers have a user provider. This defines how the
| users are actually retrieved out of your database or other storage
| mechanisms used by this application to persist your user's data.
|
| Supported: "session"
|
*/
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'passport', // set this to passport
'provider' => 'users',
'hash' => false,
],
],
/*
|--------------------------------------------------------------------------
| User Providers
|--------------------------------------------------------------------------
|
| All authentication drivers have a user provider. This defines how the
| users are actually retrieved out of your database or other storage
| mechanisms used by this application to persist your user's data.
|
| If you have multiple user tables or models you may configure multiple
| sources which represent each model / table. These sources may then
| be assigned to any extra authentication guards you have defined.
|
| Supported: "database", "eloquent"
|
*/
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => App\Models\User::class,
],
// 'users' => [
// 'driver' => 'database',
// 'table' => 'users',
// ],
],
/*
|--------------------------------------------------------------------------
| Resetting Passwords
|--------------------------------------------------------------------------
|
| You may specify multiple password reset configurations if you have more
| than one user table or model in the application and you want to have
| separate password reset settings based on the specific user types.
|
| The expiry time is the number of minutes that each reset token will be
| considered valid. This security feature keeps tokens short-lived so
| they have less time to be guessed. You may change this as needed.
|
| The throttle setting is the number of seconds a user must wait before
| generating more password reset tokens. This prevents the user from
| quickly generating a very large amount of password reset tokens.
|
*/
'passwords' => [
'users' => [
'provider' => 'users',
'table' => 'password_reset_tokens',
'expire' => 60,
'throttle' => 60,
],
],
/*
|--------------------------------------------------------------------------
| Password Confirmation Timeout
|--------------------------------------------------------------------------
|
| Here you may define the amount of seconds before a password confirmation
| times out and the user is prompted to re-enter their password via the
| confirmation screen. By default, the timeout lasts for three hours.
|
*/
'password_timeout' => 10800,
];
#5 Create Controller
Now, you need to create an authentication controller where we will update the code for login and registration, user access token and logout.
So run the following command and generate the new controller.
php artisan make:controller Api/AuthControllerAfter successfully generating the controller now open the app\Http\Controllers\Api\AuthController.php file and update the following code on it.
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Facades\Hash;
use App\Models\User;
class AuthController extends Controller
{
public function register(Request $request)
{
$requestData = $request->all();
$validator = Validator::make($requestData,[
'name' => 'required|max:55',
'email' => 'email|required|unique:users',
'password' => 'required|confirmed',
'password_confirmation' => 'required'
]);
if ($validator->fails()) {
return response()->json([
'errors' => $validator->errors()
], 422);
}
$requestData['password'] = Hash::make($requestData['password']);
User::create($requestData);
return response([ 'status' => true, 'message' => 'User successfully register.' ], 200);
}
public function login(Request $request)
{
$requestData = $request->all();
$validator = Validator::make($requestData,[
'email' => 'email|required',
'password' => 'required'
]);
if ($validator->fails()) {
return response()->json([
'errors' => $validator->errors()
], 422);
}
if(! auth()->attempt($requestData)){
return response()->json(['error' => 'UnAuthorised Access'], 401);
}
$accessToken = auth()->user()->createToken('authToken')->accessToken;
return response(['user' => auth()->user(), 'access_token' => $accessToken], 200);
}
public function user(Request $request)
{
$user = $request->user();
return response()->json(['user' => $user], 200);
}
public function logout (Request $request)
{
$token = $request->user()->token();
$token->revoke();
return response(['message' => 'You have been successfully logged out!'], 200);
}
}#6 Make Routes for Passport Authentication
Now, we will define API routes. Go to the routes/api.php file and declare the foundational code.
<?php
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use App\Http\Controllers\Api\AuthController;
/*
|--------------------------------------------------------------------------
| API Routes
|--------------------------------------------------------------------------
|
| Here is where you can register API routes for your application. These
| routes are loaded by the RouteServiceProvider and all of them will
| be assigned to the "api" middleware group. Make something great!
|
*/
Route::post('register', [AuthController::class, 'register']);
Route::post('login', [AuthController::class, 'login']);
Route::middleware('auth:api')->group(function () {
Route::get('/user', [AuthController::class, 'user']);
Route::post('/logout', [AuthController::class, 'logout']);
});
// Route::middleware('auth:sanctum')->get('/user', function (Request $request) {
// return $request->user();
// });
#7 Test Laravel 10 Passport Api
We have successfully created the Laravel authentication using Passport. So we will run the php artisan command to test our api’s.
php artisan serve
Create New User
To create a new user you need to set a POST request with your API url http://127.0.0.1:8000/api/register and add the name, email, password and password_confirmation.
Login User
For login api you need to make a POST request to http://127.0.0.1:8001/api/ login with your email and password.
Get Login User
After the login, copy the value of the access_token from the response and click on the Authorization tab and select Bearer Token from the dropdown and paste the value of the access_token copied earlier:
You need to set this access token as a Bearer Token in the Authorization header.
'headers' => [
'Accept' => 'application/json',
'Authorization' => 'Bearer '. $accessToken,
]Open the Postman app and Headers tab, define “Accept”: application/json header value:
#7 Conclusion
Finally, the Laravel Passport API authentication example is ended, hope you will like it. Laravel Passport is easy to install and configure, also we can generate a multi-token, with a specific role given to every token.
This example tested with the below Laravel version.
- Laravel 5
- Laravel 6
- Laravel 7
- Laravel 8
- Laravel 9
- Laravel 10