Add the user role to the jwt, laravel 5 jwt-auth

Question

I have a laravel 5 backend that sends an jwt-token as a json response on login with jwt-auth.

Now I would like to add the user role to the jwt token that laravel sends, I tried the following way:

This is my current controller

<?php 
namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use JWTAuth;
use Tymon\JWTAuth\Exceptions\JWTException;
use Illuminate\Database\Eloquent\Model;
use App\User;

class AuthenticateController extends Controller
{
    public function authenticate(Request $request)
    {
        // grab credentials from the request
        $credentials = $request->only('email', 'password');
        $user = User::where('email', '=', $credentials['email'])->first();
        $customClaims = ['role' => $user->role];

        try {
            // attempt to verify the credentials and create a token for the user
            if (! $token = JWTAuth::attempt($credentials, $customClaims)) {
                return response()->json(['error' => 'invalid_credentials'], 401);
            }
        } catch (JWTException $e) {
            // something went wrong whilst attempting to encode the token
            return response()->json(['error' => 'could_not_create_token'], 500);
        }
        // all good so return the token
        return response()->json(compact('token'));
    }
}
?>

Is there a cleaner way to do this ?

JWT for php is bad documented. To make a simple login/logout system is painful! See my questions about it. — Maykonn
– Maykonn, Commented Apr 16, 2015 at 2:07
you can create a token from anything you like. it doesn't have to be a user or a set of permissions. github.com/tymondesigns/jwt-auth/wiki/… So i think it's better to set this login on your model or repository and call it ? — astroanu
– astroanu, Commented Sep 4, 2015 at 5:59

Olatunde Alex-Oni · Accepted Answer · 2017-01-21 13:47:33Z

3

You are currently querying for the user twice, once using the email for the purpose of getting the role and the second within the jwt::attempt() method.I would suggest reducing the queries to just one but doing the authentication {Auth::attempt($credientials)} and then passing the retrieved user into JWT::fromUser() method, along with the custom claim. so

JWT::fromUser($user,['role' => $user->role])

edited Jan 21, 2017 at 13:47

answered Jan 21, 2017 at 13:20

Olatunde Alex-Oni

543 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Sumit Over a year ago

This link auth.readthedocs.io/en/develop/quick-start solved my problem.

Francesco Malatesta · Accepted Answer · 2015-09-06 10:26:19Z

1

It's strange, specifying some $customClaims as second parameter for the attempt() method actually works for me.

However, have you tried to use the JWTFactory Facade? It lets you create every kind of token you want.

You can get more info here: JWT-Auth Creating Tokens Page.

As the installation guide suggests, don't forget to add it as a Facade while installing JWT-Auth!

Hope it helps!

answered Sep 6, 2015 at 10:26

Francesco Malatesta

6793 silver badges6 bronze badges

Comments

Lithium · Accepted Answer · 2016-04-27 14:51:43Z

0

It seems that there isn't a cleaner way in the current stable version of JWTAuth[0.5.9].

Take a look on the following issues #89 #108

As the author pointed out in his comments there will be improvements in his next release covering this issue. You can take a look on his develop branch.

answered Apr 27, 2016 at 14:51

Lithium

111 silver badge1 bronze badge

Comments

DarkMukke · Accepted Answer · 2018-12-05 12:44:04Z

0

JWT v1.0's documentation causes confusion.
Add this method to your user model, so you can add custom claims when you authenticate users:

public function getJWTCustomClaims()
{

        return = [
            'type' => 'driver',
            'id' => $this->driver->id
        ];
}

edited Dec 5, 2018 at 12:44

DarkMukke

2,4891 gold badge24 silver badges32 bronze badges

answered Dec 5, 2018 at 12:10

Cyber

91 silver badge2 bronze badges

Collectives™ on Stack Overflow

Add the user role to the jwt, laravel 5 jwt-auth

4 Answers 4

1 Comment

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related