Check JWT optional

Prerequisites

The creation of JWT tokens will require install and setup library.

Depends job description

Interaction with the library functionality is done through a special Depends function that allows you to save the type of data being transferred and perform payload validation of tokens.

In addition to the standard token checks described in Check JWT, there are depends that perform an optional token check.

That is, if the token was not found or is invalid, the function will return None instead of the token payload.

Examples

Access token

To check the access token you need to use the function check_jwt_depends

from pydantic import BaseModel
from quick_jwt import (
    access_check_optional_depends
)

class UserScheme(BaseModel):
    sub: str


@app.get("/access-token-check-optional")
async def access_token_check_optional(
        user: access_check_optional_depends(UserScheme)
) -> UserScheme | None:
    return user

What happened?

The access_token_check_optional function was passed a scheme into which the access token payload will be converted. Also, a field for sending the token via headers or cookies appeared in the endpoint.

Refresh token

In addition to checking the access token, you can also check the refresh token:

from pydantic import BaseModel
from quick_jwt import (
    refresh_check_optional_depends
)

class UserScheme(BaseModel):
    sub: str


@app.get("/refresh-token-check-optional")
async def refresh_token_check_optional(
        user: refresh_check_optional_depends(UserScheme)
) -> UserScheme | None:
    return user

What happened?

The refresh_check_optional_depends function was passed a scheme into which the refresh token payload will be converted. Also, a field for sending the token via headers or cookies appeared in the endpoint.