DEV Community

Build a JWT Authenticated API with Lumen(v5.8)

Ndifreke Friday on August 24, 2019

In this tutorial, we will be using lumen; a super-fast micro-framework by laravel to build a simple and secure REST API. At the end of this tutoria...

Read full post

dhaval-dignizant • Oct 16 '19

getting this error after install jwt

php artisan jwt:secret

There are no commands defined in the "jwt" namespace.

B6T3M6N • Oct 24 '19

Had the same issue.

following the docs here jwt-auth.readthedocs.io/en/develop...
especially the chapter Bootstrap file changes fixed the issue

Add the following snippet to the bootstrap/app.php file under the providers section as follows:

// Uncomment this line
$app->register(App\Providers\AuthServiceProvider::class);

// Add this line
$app->register(Tymon\JWTAuth\Providers\LumenServiceProvider::class);

Ndifreke Friday • Oct 16 '19

Please check to make sure tymon/jwt-auth installed successfully

Also type php artisan to see available commands.

Keep me posted on your progress.

Ndifreke Friday • Oct 16 '19

Side note: the command jwt:secret updates your .env file with something like JWT_SECRET=secretkeystring.

"It is the key that will be used to sign your tokens. How that happens exactly will depend on the algorithm that you choose to use."

dhaval-dignizant • Oct 17 '19

now it's working. Thank you.

Ndifreke Friday • Oct 17 '19

You are welcome

dhaval-dignizant • Oct 18 '19

Hi Ndifreke,
can you explain how to publish jwt library also need to token expire time and refresh token. thank you in advance.

Ndifreke Friday • Oct 18 '19

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

The above command publishes the JWTAuth Package. Here's this thing, the vendor:publish command is not available in lumen.
You can try using third party packages to pull this in ( github.com/laravelista/lumen-vendo... )

For managing expiration time and refreshing tokens, this link should help out; jwt-auth.readthedocs.io/en/develop...

dhaval-dignizant • Oct 18 '19

Hi Ndifreke,
Thanks for reply. one more thing I need if you help me. you have any example for lumen with vue also include in jwt token use.

Chris Leathley • Oct 31 '19 • Edited

you might want to also add

use Illuminate\Support\Facades\Auth;

when you add respondWithToken to app/Http/Controllers/Controller.php (Lumin 6+)

Cabello, Hector Guillermo • Nov 5 '19

This is key.

I was followed step by step your tutorial, writing the code by myself (i mean, without clone your github project) and without this line (thanks @cleathley ) an error appears.

I think you should edit your post and add that line after you explain this:
«Add a global respondWithToken method to Controller class»

Anyway, great tutorial. It help me a lot!!

Ndifreke Friday • Nov 6 '19 • Edited

I'm glad it helped 👍

I will update the post, so new readers don't run into this same error.

Syns • Nov 13 '19

This saved my life ty

Ndifreke Friday • Nov 6 '19

Thanks For this, I will update the tutorial to help people not encounter this error in the future.

Walid Yacine MAZED • Nov 25 '19 • Edited

First of all great tutorial, thanks a lot for all your efforts dude, I've a question, how can I set a remember me system with JWT token ? And also, how to increase expiration duration from the config file (config/auth.php) ?

Ndifreke Friday • Nov 26 '19 • Edited

Would there be a need for remember me? As long as the client has the token; they have access to the system.

You could extend token's time to live for those type of users, that could work...I think.

Override the token ttl
$token = auth()->setTTL(7200)->attempt($credentials);

Further Reading
stackoverflow.com/questions/236038...

Walid Yacine MAZED • Dec 15 '19 • Edited

Thanks dude, I've another question please, if the token is stocked localy, then yo access protected area I've check the user token for that, if Auth::user() did the job, why we stock the token localy ?

Walid Yacine MAZED • Nov 25 '19

For the second part of the question, the answer should be:
github.com/tymondesigns/jwt-auth/b...

Debabrata Karfa • Nov 21 '19 • Edited

Getting this error,

In Connection.php line 665:

SQLSTATE[HY000] [2002] Connection refused (SQL: create table migrations (id int unsigned not null auto_increment primary key, migration varchar(255) not null, batch int not
null) default character set utf8mb4 collate 'utf8mb4_unicode_ci')

In Connector.php line 70:

SQLSTATE[HY000] [2002] Connection refused

Using Homestead development environment.

Ndifreke Friday • Nov 26 '19 • Edited

This error is due to PHP not being able to connect to MySQL

"Create a .env file, copy all contents in .env.example into the .env file and add your database configurations."

racedaemon • Oct 5 '20

This was of great help. The only problem I encountered was when running php artisan jwt:secret.
$app->register(Tymon\JWTAuth\Providers\LumenServiceProvider::class); needs to be added to app.php before the command is executed.

jaimin-hothi • Oct 9 '20 • Edited

Hi,
Thanks for your great tutorial.
But I want a custom field (email and password) both so could you make it an example for that.

My field name = USER_NAME, PASSWORD (Both are capital)

I try but token always false.

If you do then its great help for me.

Thank you

Fongoh Martin T. • Nov 21 '19

Nice tutorial, very clear and straight to the point. My worry is why the dev-develope branch? The main branch, does it have an issue?

Ndifreke Friday • Nov 26 '19

For some reason the dev-develop branch has always worked for new versions of lumen, the next best thing would be version @2.0-dev

Fongoh Martin T. • Nov 26 '19

Ok thanks. I tried using the default and it keeps failing and when i use dev-develop, it worked well.

Thanks again for the tutorial, nice, easy and straight to the point.

I come again with one question. If i log into different devices, eg 4 different clients and have 4 different tokens, will all 4 be valid simultaneously? If not, what will you suggest to be done to ensure multiple tokens are valid across different devices.

Ndifreke Friday • Nov 26 '19

Every Token Generated that is yet to expired is valid; So yes, a user can have multiple tokens across multiple devices.

executions12 • Oct 21 '19

everything except php artisan jwt::secret is work...
so, i write jwt key in .env by myself..

thank you, nice tutorial...

yunchurlee • Nov 26 '19

I've just reviewed and coded through. It worked wonderfully~~~

isrortega • Jan 10 '20

Thank you, very good tutorial

Ndifreke Friday • Aug 26 '19

I am yet to come across this issue. Is there an open issue on github?

TechAutobahn • Oct 13 '20

Wonderful Bro.. It really helped me to understand the concept.. Thank you..

Guilherme Battoni • Nov 12 '19

Thanks for this article! Very straightforward and easy to understand : )

Ndifreke Friday • Nov 13 '19

I'm glad it helped :)

Ndirangu Waweru • Sep 30 '19

Nice one!

Ndifreke Friday • Oct 1 '19

Thanks!

Nazmus Sakib • Jul 31 '21

Thanks for the tutorial, helps me a lot

Tadeu Barbosa • Mar 25 '21

Great post! You had save me!

Jenuel Oras Ganawed • Jan 19 '21

how to do this when using mongodb?

Brenddon Anjos • May 25 '20

Hy bro, thanks for the tutorial. I want to know how I implements logout

Guilherme Mamedio • Jun 20 '20

public function logout () {
Auth::logout();
return response()->json(['message' => 'Successfully logged out']);
}

Ainur Rahman • Jun 5 '20

Does the lumen version affect? I use lumen version 6

Mayank Patel • Jul 8 '20

This was really helpful, man! Thanks very much.

schallernicolas • Mar 21 '20

What a great tutorial. Thank you very much!

Ndifreke Friday • Mar 21 '20

You are welcome

amanuell2 • Apr 23 '20

can you go further this post by making role-based auth in lumen?

Guilherme Milléo • Jan 14 '20

Please, can you explain how to reset the password of user?

Ndifreke Friday • Jan 15 '20

Maybe this can help
stackoverflow.com/questions/373380...

bluerabby • Dec 31 '19

getting this error when doing login request

"Method Illuminate\Auth\RequestGuard::attempt does not exist."

Any help ?

bluerabby • Dec 31 '19

Sorry, my mistake who put config/auth.php that not in root directory

WENAREEBA INNOCENT • May 24 '22

This has been an amazing tutorial , few bugs but were resolved :)-

Ali H • Apr 4 '22

thanks for sharing this great tutorial.
I had issue with ('model' => \App\User::class).
so I changed it to ('model' => \App\Models\User::class),
and it works now.