JWT token creation in FastAPI

Introduction

JWT tokens help keep users logged in safely. They store user info in a secure way so the app knows who you are.

When you want users to log in once and stay logged in while using your app.

When you need to send user info safely between the client and server.

When building APIs that require user authentication.

When you want to avoid storing session info on the server.

When you want a simple way to check if a user is allowed to do something.

Syntax

FastAPI

from datetime import datetime, timedelta
from jose import jwt

SECRET_KEY = "your-secret-key"
ALGORITHM = "HS256"

# Function to create a JWT token
# data: dict with user info
# expires_delta: optional expiration time

def create_access_token(data: dict, expires_delta: timedelta | None = None) -> str:
    to_encode = data.copy()
    expire = datetime.utcnow() + (expires_delta if expires_delta else timedelta(minutes=15))
    to_encode.update({"exp": expire})
    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
    return encoded_jwt

The exp field sets when the token expires.

Use a strong SECRET_KEY to keep tokens safe.

Examples

Creates a token with user ID 'user123' that expires in 15 minutes.

FastAPI

token = create_access_token({"sub": "user123"})

Creates a token that expires in 1 hour instead of 15 minutes.

FastAPI

token = create_access_token({"sub": "user123"}, expires_delta=timedelta(hours=1))

Sample Program

This program creates a JWT token for user 'alice' that expires in 30 minutes and prints it.

FastAPI

from datetime import datetime, timedelta
from jose import jwt

SECRET_KEY = "mysecretkey123"
ALGORITHM = "HS256"

def create_access_token(data: dict, expires_delta: timedelta | None = None) -> str:
    to_encode = data.copy()
    expire = datetime.utcnow() + (expires_delta if expires_delta else timedelta(minutes=15))
    to_encode.update({"exp": expire})
    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
    return encoded_jwt

# Example usage
if __name__ == "__main__":
    user_data = {"sub": "alice"}
    token = create_access_token(user_data, expires_delta=timedelta(minutes=30))
    print("JWT Token:", token)

Important Notes

Keep your SECRET_KEY private and never share it.

Tokens include an expiration time to improve security.

Use the jose library for easy JWT handling in FastAPI.

Summary

JWT tokens store user info safely for authentication.

Create tokens with user data and expiration time.

Use a secret key and a secure algorithm like HS256.

Practice

1. What is the main purpose of creating a JWT token in FastAPI?

easy

A. To style the user interface

B. To send emails automatically

C. To connect to a database

D. To securely store user information for authentication

Solution

1. Step 1: Understand JWT token purpose

   JWT tokens are used to safely carry user data for authentication.

2. Step 2: Identify correct use in FastAPI

   FastAPI uses JWT tokens to verify user identity securely.

3. Final Answer:

   To securely store user information for authentication -> Option D

4. Quick Check:

   JWT purpose = secure user info [OK]

Hint: JWT tokens are for secure user identity, not UI or DB [OK]

Common Mistakes:

• Confusing JWT with UI styling or database connection
• Thinking JWT sends emails
• Assuming JWT stores passwords directly

2. Which of the following is the correct way to import the function to create JWT tokens in FastAPI using PyJWT?

easy

A. import jwt.encode

B. from fastapi import jwt_encode

C. from jwt import encode

D. from fastapi.security import create_jwt

Solution

1. Step 1: Identify the JWT library used

   PyJWT is commonly used and provides an encode function imported as 'from jwt import encode'.

2. Step 2: Check FastAPI imports

   FastAPI itself does not provide jwt_encode or create_jwt functions directly.

3. Final Answer:

   from jwt import encode -> Option C

4. Quick Check:

   PyJWT encode import = from jwt import encode [OK]

Hint: PyJWT encode is imported from jwt, not fastapi [OK]

Common Mistakes:

• Trying to import JWT functions directly from FastAPI
• Using incorrect import syntax
• Confusing module names

3. Given this code snippet, what will be the output of the print(token) statement?

from jwt import encode

payload = {"user_id": 123}
secret = "mysecret"
algorithm = "HS256"
token = encode(payload, secret, algorithm=algorithm)
print(token)

medium

A. A JWT token string encoded with user_id 123

B. An error because algorithm parameter is missing

C. The original payload dictionary printed

D. None, because encode returns nothing

Solution

1. Step 1: Understand encode function behavior

   The encode function creates a JWT token string from the payload using the secret and algorithm.

2. Step 2: Analyze the code snippet

   Payload and secret are provided correctly, algorithm is set to HS256, so encode returns a JWT token string.

3. Final Answer:

   A JWT token string encoded with user_id 123 -> Option A

4. Quick Check:

   encode returns JWT string [OK]

Hint: encode returns a token string, not the original data [OK]

Common Mistakes:

• Expecting encode to print the payload
• Missing algorithm causes error (not true here)
• Thinking encode returns None

4. Identify the error in this JWT token creation code snippet:

from jwt import encode

payload = {"user_id": 42}
secret = "secretkey"
token = encode(payload, secret)
print(token)

medium

A. Missing algorithm parameter causes an error

B. No error; code runs correctly

C. Secret key should be bytes, not string

D. Payload must be a string, not a dictionary

Solution

1. Step 1: Check encode function requirements

   PyJWT's encode has a default algorithm='HS256', so it is not strictly required.

2. Step 2: Analyze the code snippet

   The code calls encode with payload and secret; algorithm defaults to HS256, so it runs correctly and produces a token.

3. Final Answer:

   No error; code runs correctly -> Option B

4. Quick Check:

   Algorithm defaults to HS256 = no error [OK]

Hint: PyJWT encode defaults to HS256 algorithm [OK]

Common Mistakes:

• Assuming algorithm defaults to HS256
• Thinking payload must be string
• Believing secret must be bytes

5. You want to create a JWT token in FastAPI that expires in 30 minutes. Which code snippet correctly adds the expiration time to the payload before encoding?

hard

A. payload = {"user_id": 1, "exp": datetime.utcnow() + timedelta(minutes=30)}

B. payload = {"user_id": 1, "exp": str(datetime.utcnow() + timedelta(minutes=30))}

C. payload = {"user_id": 1, "exp": time.time() + 1800}

D. payload = {"user_id": 1, "exp": datetime.now() + timedelta(minutes=30)}

Solution

1. Step 1: Understand JWT expiration format

   The 'exp' claim must be a UTC datetime or a timestamp representing expiration time.

2. Step 2: Evaluate each option

   payload = {"user_id": 1, "exp": datetime.utcnow() + timedelta(minutes=30)} uses datetime.utcnow() + timedelta for 30 minutes, which is correct. payload = {"user_id": 1, "exp": str(datetime.utcnow() + timedelta(minutes=30))} converts datetime to string, which is invalid. payload = {"user_id": 1, "exp": time.time() + 1800} uses time.time() but JWT expects datetime or timestamp as int, so this may cause issues. payload = {"user_id": 1, "exp": datetime.now() + timedelta(minutes=30)} uses datetime.now() which is local time, not UTC, causing potential errors.

3. Final Answer:

   payload = {"user_id": 1, "exp": datetime.utcnow() + timedelta(minutes=30)} -> Option A

4. Quick Check:

   Use UTC datetime for 'exp' claim [OK]

Hint: Use datetime.utcnow() + timedelta for expiration [OK]

Common Mistakes:

• Using local time instead of UTC
• Converting datetime to string for 'exp'
• Using wrong time functions like time.time() without conversion