Laravel InvalidArgumentException: Auth guard [api] is not defined

Getting to know the mistake:

When using Laravel or Lumen APIs, developers might see the error "Auth guard driver [api] is not defined." This error usually happens when the authentication system tries to use an API guard that isn't set up correctly in the authentication settings. Because of this, the framework can't figure out how API authentication should work.

You might see the error in different ways, like "InvalidArgumentException: Auth guard [api] is not defined" or "Lumen 5.4 – Auth guard driver [api] is not defined." No matter what the message format is, the problem is usually the same: the project's authentication configuration file is missing or has the wrong settings for the API guard.

Authentication guards in Laravel and Lumen tell the system how to check who is who for each request. The web guard is often used by web apps, and the token-based guard is often used by APIs. The system can't verify API requests if the API guard isn't set up correctly.

This problem happens a lot when developers make REST APIs, add authentication packages, or move projects from one version of Laravel to another. To fix this error quickly and make sure that API authentication is safe, you need to know how the auth.php file is set up.

Common Reasons

Here are some of the most common reasons why the "Auth guard driver [api] is not defined" error happens. 

1. API Guard Configuration is missing

This error happens most often because the config/auth.php file does not define the API guard. Laravel needs a guard configuration that tells the system which provider and driver to use for API authentication. This exception is thrown by the framework if the guard is not there. 

2. Wrong Authentication Driver 

The API guard is sometimes there, but the driver isn't set up right. For instance, if you are using Passport, JWT, or token authentication, the driver must match the package that is already installed. The error can happen when the driver and the authentication package that is already installed don't match. 

Mistake:

There is no definition for the auth guard driver [API].
There is no definition for the Auth guard driver [api] in Lumen 5.4.
InvalidArgumentException: The auth guard [api] is not set up.

Solution:

The auth file is missing the API guard driver, which is what it is. To start, we need to set up the API guard.

Open the file config/auth.php. 

We can see that the default web guard is already defined.

Here, we need to define API guard. Add the following code to the guard's array.

 'api' => [

            'driver' => 'token',

            'provider' => 'users',

        ],

If you are using any package, then update the API index accordingly.

For passport, package add 

'api' => [
            'driver' => 'passport',
            'provider' => 'users',
        ],

For jwt package add 

'api' => [
            'driver' => 'jwt',
            'provider' => 'users',
        ],

After adding or updating the API guard driver, please run composer update using the following command.

composer update.

Final Thoughts

There is no definition for the Auth guard driver [api]. Developers who work with Laravel or Lumen APIs often run into this problem with their settings. It happens when the framework can't find the API guard settings in the authentication settings. Laravel can't figure out how to authenticate API requests without this setup. 

Most of the time, all you have to do to fix the problem is add the API guard to the config/auth.php file. Depending on whether they are using token authentication, Passport, or JWT packages, developers should make sure they are using the right authentication driver. 

Setting up authentication guards correctly is an important step in making APIs safe. Developers can avoid many common mistakes and make sure their API authentication works correctly by learning how guards and providers work together in Laravel's authentication system. 

If you run into similar problems, always check your auth settings, make sure the authentication packages you installed are still working, and update your project dependencies. Laravel's authentication system will work well and safely for both web and API apps if you set it up correctly. 

That's all we have to do. Please leave any questions or suggestions you have in the comments section.