API authentication with Sanctum in Laravel - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to enable Sanctum middleware for API routes.

Laravel

Route::middleware('[1]')->get('/user', function (Request $request) {
    return $request->user();
});

Drag options to blanks, or click blank then click option'

Aauth:sanctum

Bguest

Cweb

Dapi

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'auth' or 'api' middleware instead of 'auth:sanctum'.

Forgetting to add middleware to the route.

The middleware auth:sanctum protects API routes using Sanctum tokens.

2fill in blank

medium

Complete the code to issue a token for the authenticated user.

Laravel

$token = $user->createToken('[1]')->plainTextToken;

Drag options to blanks, or click blank then click option'

Asession

Bpassword

Cauth

Dapi-token

Attempts:

3 left

💡 Hint

Common Mistakes

Using reserved words like 'password' or 'auth' as token names.

Leaving the token name empty.

The createToken method requires a token name, often a descriptive string like 'api-token'.

3fill in blank

hard

Fix the error in the middleware registration for Sanctum in the HTTP kernel.

Laravel

'api' => [
    'throttle:api',
    '[1]',
],

Drag options to blanks, or click blank then click option'

Aauth

Bauth:sanctum

Cguest

Dweb

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'auth' instead of 'auth:sanctum'.

Omitting the Sanctum middleware from the 'api' group.

The Sanctum middleware is auth:sanctum, which must be added to the 'api' middleware group.

4fill in blank

hard

Fill both blanks to complete the Sanctum token revocation code.

Laravel

$user->tokens()->where('[1]', '[2]')->delete();

Drag options to blanks, or click blank then click option'

Aid

Bname

Ctoken

Dcreated_at

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'id' or 'created_at' instead of 'name' to filter tokens.

Trying to delete tokens without filtering.

To revoke a specific token, filter tokens by their name matching the token value, then delete.

5fill in blank

hard

Fill all three blanks to complete the middleware and route group setup for Sanctum API authentication.

Laravel

Route::middleware(['[1]', '[2]'])->prefix('[3]')->group(function () {
    Route::get('/profile', function () {
        return auth()->user();
    });
});

Drag options to blanks, or click blank then click option'

Aauth:sanctum

Bthrottle:api

Capi

Dguest

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'auth' instead of 'auth:sanctum'.

Missing the 'throttle:api' middleware.

Incorrect route prefix.

The route group uses auth:sanctum for authentication, throttle:api for rate limiting, and the prefix api for API routes.

Practice

1. What is the main purpose of Laravel Sanctum in API development?

easy

A. To handle frontend routing in Laravel apps

B. To provide simple token-based API authentication

C. To manage database migrations automatically

D. To optimize SQL queries for performance

Solution

1. Step 1: Understand Sanctum's role

   Sanctum is designed to provide a simple way to authenticate API requests using tokens.

2. Step 2: Compare options

   The incorrect options relate to frontend routing, database migrations, and SQL query optimization, which are other Laravel features, not Sanctum's main purpose.

3. Final Answer:

   To provide simple token-based API authentication -> Option B

4. Quick Check:

   Sanctum = API token authentication [OK]

Hint: Sanctum = simple API token auth [OK]

Common Mistakes:

• Confusing Sanctum with database or routing features
• Thinking Sanctum manages frontend or SQL optimization

2. Which of the following is the correct way to protect an API route using Sanctum middleware in Laravel?

easy

A. Route::middleware('auth:sanctum')->get('/user', function () { return auth()->user(); });

B. Route::middleware('api')->get('/user', function () { return auth()->user(); });

C. Route::middleware('sanctum')->get('/user', function () { return auth()->user(); });

D. Route::middleware('auth')->get('/user', function () { return auth()->user(); });

Solution

1. Step 1: Identify Sanctum middleware syntax

   Sanctum uses 'auth:sanctum' middleware to protect routes requiring token authentication.

2. Step 2: Check each option

   Route::middleware('auth:sanctum')->get('/user', function () { return auth()->user(); }); uses 'auth:sanctum' correctly; others use incorrect or incomplete middleware names.

3. Final Answer:

   Route::middleware('auth:sanctum')->get('/user', function () { return auth()->user(); }); -> Option A

4. Quick Check:

   Sanctum middleware = 'auth:sanctum' [OK]

Hint: Use 'auth:sanctum' middleware to protect API routes [OK]

Common Mistakes:

• Using 'auth' instead of 'auth:sanctum'
• Omitting middleware or using wrong names like 'sanctum' alone
• Confusing 'api' middleware with Sanctum middleware

3. Given this code snippet, what will be the output when a valid token is used to access the route?

use Illuminate\Http\Request;

Route::middleware('auth:sanctum')->get('/profile', function (Request $request) {
    return $request->user()->name;
});

medium

A. The name of the authenticated user

B. An error: Method user() does not exist

C. Null, because user() returns nothing

D. The user's email address

Solution

1. Step 1: Understand the middleware effect

   The 'auth:sanctum' middleware ensures the request is authenticated and $request->user() returns the authenticated user model.

2. Step 2: Analyze the return statement

   The code returns $request->user()->name, which outputs the authenticated user's name.

3. Final Answer:

   The name of the authenticated user -> Option A

4. Quick Check:

   $request->user()->name = user name [OK]

Hint: auth:sanctum gives user() object; name property outputs user name [OK]

Common Mistakes:

• Assuming user() returns null or causes error
• Confusing user name with email
• Ignoring middleware authentication effect

4. Identify the error in this code snippet for issuing a Sanctum API token:

use App\Models\User;

$user = User::find(1);
$token = $user->createToken;
return $token->plainTextToken;

medium

A. User model does not support createToken method

B. User::find(1) returns null causing error

C. plainTextToken is not a valid property

D. Missing parentheses when calling createToken() method

Solution

1. Step 1: Check method call syntax

   The createToken method must be called with parentheses and a token name string, e.g. createToken('token-name').

2. Step 2: Analyze given code

   The code uses $user->createToken without parentheses, so it references the method, not calls it, causing an error.

3. Final Answer:

   Missing parentheses when calling createToken() method -> Option D

4. Quick Check:

   Method calls need parentheses () [OK]

Hint: Always call createToken() with parentheses and token name [OK]

Common Mistakes:

• Forgetting parentheses on method calls
• Not passing token name string to createToken()
• Assuming plainTextToken is invalid

5. You want to issue a token for a user and restrict it to only allow access to 'orders' and 'products' API scopes. Which code snippet correctly creates this token with scopes using Laravel Sanctum?

hard

A. $token = $user->createToken('api-token', 'orders', 'products');

B. $token = $user->createToken('api-token')->scopes(['orders', 'products']);

C. $token = $user->createToken('api-token', ['orders', 'products']);

D. $token = $user->createToken(['orders', 'products']);

Solution

1. Step 1: Review createToken method signature

   The createToken method accepts the token name as first argument and an array of scopes as second argument.

2. Step 2: Evaluate each option

   $token = $user->createToken('api-token', ['orders', 'products']); correctly passes the token name and scopes array. $token = $user->createToken('api-token')->scopes(['orders', 'products']); incorrectly chains scopes() which does not exist. $token = $user->createToken('api-token', 'orders', 'products'); passes scopes as separate arguments, which is invalid. $token = $user->createToken(['orders', 'products']); passes scopes as first argument without token name.

3. Final Answer:

   $token = $user->createToken('api-token', ['orders', 'products']); -> Option C

4. Quick Check:

   createToken(name, scopes array) = correct [OK]

Hint: Pass scopes as second argument array in createToken() [OK]

Common Mistakes:

• Passing scopes as separate arguments instead of array
• Trying to chain scopes() method
• Omitting token name argument