Bearer token handling in FastAPI

Introduction

Bearer token handling lets your FastAPI app check who is making a request. It helps keep your app safe by allowing only users with a valid token to access certain parts.

When you want to protect API routes so only logged-in users can use them.

When your app needs to check user identity without asking for username and password every time.

When you build an app that talks to other services and needs to send a token to prove it is allowed.

When you want to easily add security to your API using standard token methods.

Syntax

FastAPI

from fastapi import FastAPI, Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.get("/items/")
async def read_items(token: str = Depends(oauth2_scheme)):
    return {"token": token}

OAuth2PasswordBearer is a helper that extracts the bearer token from the request header.

The Depends function tells FastAPI to use the token from the request automatically.

Examples

This sets up the way to get the token from the request header.

FastAPI

from fastapi.security import OAuth2PasswordBearer

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

This example shows how to get the token inside a route handler.

FastAPI

from fastapi import FastAPI, Depends

app = FastAPI()

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.get("/users/me")
async def read_current_user(token: str = Depends(oauth2_scheme)):
    return {"token_received": token}

This example checks if the token is correct and denies access if not.

FastAPI

from fastapi import FastAPI, Depends, HTTPException, status

app = FastAPI()

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.get("/secure-data")
async def secure_data(token: str = Depends(oauth2_scheme)):
    if token != "expected_token":
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="Invalid authentication credentials",
            headers={"WWW-Authenticate": "Bearer"},
        )
    return {"data": "This is protected"}

Sample Program

This FastAPI app has one protected route. It expects a bearer token in the request header. If the token is not exactly "mysecrettoken", it returns an error. Otherwise, it shows a success message with the token.

FastAPI

from fastapi import FastAPI, Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer

app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.get("/protected")
async def protected_route(token: str = Depends(oauth2_scheme)):
    if token != "mysecrettoken":
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="Invalid or missing token",
            headers={"WWW-Authenticate": "Bearer"},
        )
    return {"message": "Access granted with token: " + token}

Important Notes

Always use HTTPS to keep bearer tokens safe during transmission.

The tokenUrl parameter in OAuth2PasswordBearer is the URL where clients get tokens; it does not have to be implemented for token extraction to work.

Bearer tokens are usually sent in the header as: Authorization: Bearer <token>

Summary

Bearer token handling helps secure API routes by checking tokens sent by clients.

FastAPI's OAuth2PasswordBearer makes it easy to get the token from requests.

You can check the token value and reject requests without valid tokens.

Practice

1. What is the main purpose of using a Bearer token in FastAPI?

easy

A. To serve static files efficiently

B. To format JSON responses automatically

C. To speed up database queries

D. To securely identify and authorize API requests

Solution

1. Step 1: Understand Bearer token role

   Bearer tokens are used to prove the client has permission to access protected routes.

2. Step 2: Identify purpose in FastAPI

   FastAPI uses Bearer tokens to check authorization before allowing access to API endpoints.

3. Final Answer:

   To securely identify and authorize API requests -> Option D

4. Quick Check:

   Bearer token = Authorization [OK]

Hint: Bearer tokens are for security and access control [OK]

Common Mistakes:

• Confusing token with response formatting
• Thinking token speeds up database
• Assuming token serves static files

2. Which FastAPI class is used to extract a Bearer token from the Authorization header?

easy

A. OAuth2PasswordBearer

B. HTTPBasicCredentials

C. OAuth2PasswordRequestForm

D. APIKeyHeader

Solution

1. Step 1: Recall FastAPI token extraction classes

   OAuth2PasswordBearer is designed to read Bearer tokens from the Authorization header.

2. Step 2: Match class to Bearer token usage

   OAuth2PasswordRequestForm is for form data, HTTPBasicCredentials is for basic auth, APIKeyHeader is for API keys, so only OAuth2PasswordBearer fits Bearer tokens.

3. Final Answer:

   OAuth2PasswordBearer -> Option A

4. Quick Check:

   Bearer token extractor = OAuth2PasswordBearer [OK]

Hint: Bearer token uses OAuth2PasswordBearer class [OK]

Common Mistakes:

• Using OAuth2PasswordRequestForm for token extraction
• Confusing basic auth with Bearer token
• Choosing APIKeyHeader for Bearer tokens

3. Given this FastAPI dependency:

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.get("/users/me")
async def read_users_me(token: str = Depends(oauth2_scheme)):
    return {"token": token}

What will be the output if the client sends a request with header Authorization: Bearer abc123?

medium

A. {"token": "Bearer abc123"}

B. HTTP 401 Unauthorized error

C. {"token": "abc123"}

D. {"token": null}

Solution

1. Step 1: Understand OAuth2PasswordBearer behavior

   This class extracts only the token string after 'Bearer ' from the Authorization header.

2. Step 2: Analyze the returned value

   The function returns a JSON with the token string, so it will return {"token": "abc123"}.

3. Final Answer:

   {"token": "abc123"} -> Option C

4. Quick Check:

   Bearer token string extracted = "abc123" [OK]

Hint: OAuth2PasswordBearer strips 'Bearer ' prefix automatically [OK]

Common Mistakes:

• Expecting full 'Bearer abc123' string returned
• Assuming 401 error without token validation
• Thinking token is null if present

4. What is wrong with this FastAPI code snippet for Bearer token validation?

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

@app.get("/items/")
async def read_items(token: str = Depends(oauth2_scheme)):
    if token == None:
        raise HTTPException(status_code=401, detail="Invalid token")
    return {"token": token}

medium

A. The token check should use 'if not token' instead of 'if token == None'

B. OAuth2PasswordBearer does not extract tokens from headers

C. The route path should not end with a slash

D. HTTPException requires a status_code of 403 for invalid tokens

Solution

1. Step 1: Check token validation logic

   OAuth2PasswordBearer returns a string or raises an error if missing; token is never None but can be empty or missing.

2. Step 2: Correct token presence check

   Using 'if not token' is safer to catch empty strings or missing tokens rather than 'token == None'.

3. Final Answer:

   The token check should use 'if not token' instead of 'if token == None' -> Option A

4. Quick Check:

   Token presence check = 'if not token' [OK]

Hint: Check token presence with 'if not token' for safety [OK]

Common Mistakes:

• Using 'token == None' which misses empty strings
• Thinking OAuth2PasswordBearer doesn't extract tokens
• Confusing HTTP status codes for auth errors

5. You want to protect a FastAPI route so only requests with the exact Bearer token "secret123" are allowed. Which code snippet correctly implements this?

hard

A. async def protected_route(token: str = Depends(oauth2_scheme)):
if token == None:
return {"message": "Access granted"}
raise HTTPException(status_code=401, detail="Unauthorized")

B. async def protected_route(token: str = Depends(oauth2_scheme)):
if token != "secret123":
raise HTTPException(status_code=401, detail="Unauthorized")
return {"message": "Access granted"}

C. async def protected_route(token: str):
if token == "secret123":
return {"message": "Access granted"}
raise HTTPException(status_code=403, detail="Forbidden")

D. async def protected_route(token: str = Depends(oauth2_scheme)):
if token == "Bearer secret123":
return {"message": "Access granted"}
raise HTTPException(status_code=401, detail="Unauthorized")

Solution

1. Step 1: Use OAuth2PasswordBearer dependency

   We must use Depends(oauth2_scheme) to extract the token from the Authorization header.

2. Step 2: Check token value correctly

   The token string is just the token without 'Bearer ' prefix, so compare directly to "secret123" and raise 401 if not matching.

3. Final Answer:

   async def protected_route(token: str = Depends(oauth2_scheme)): if token != "secret123": raise HTTPException(status_code=401, detail="Unauthorized") return {"message": "Access granted"} -> Option B

4. Quick Check:

   Compare token string directly to "secret123" [OK]

Hint: Compare token string directly, no 'Bearer ' prefix included [OK]

Common Mistakes:

• Comparing token to 'Bearer secret123' including prefix
• Not using Depends(oauth2_scheme) to get token
• Returning access granted when token is None