jam.ext.starlette.auth_backends

auth_backends

Classes:

Name	Description
JWTBackend	JWT Backend for Starlette AuthenticationMiddleware.
SessionBackend	Sessions backend for starlette.

JWTBackend

JWTBackend(
    jam: BaseJam,
    cookie_name: Optional[str] = None,
    header_name: Optional[str] = "Authorization",
)

Bases: AuthenticationBackend

JWT Backend for Starlette AuthenticationMiddleware.

Parameters:

Name	Type	Description	Default
jam	BaseJam	Jam instance	required
cookie_name	str | None	Access token cookie name	None
header_name	str | None	Access token header name	'Authorization'

Methods:

Name	Description
authenticate	Starlette authentication handler.

authenticate async

authenticate(
    conn: HTTPConnection,
) -> Optional[tuple[AuthCredentials, BaseUser]]

Starlette authentication handler.

SessionBackend

SessionBackend(
    jam: BaseJam,
    cookie_name: Optional[str] = "sessionId",
    header_name: Optional[str] = None,
)

Bases: AuthenticationBackend

Sessions backend for starlette.

Parameters:

Name	Type	Description	Default
jam	BaseJam	Jam instance	required
cookie_name	str | None	Session id cookie name	'sessionId'
header_name	str | None	Session id header name	None

Methods:

Name	Description
authenticate	Starlette authentication handler.

authenticate async

authenticate(
    conn: HTTPConnection,
) -> Optional[tuple[AuthCredentials, BaseUser]]

Starlette authentication handler.

FILE PATH: jam/ext/starlette/auth_backends.py