Skip to content

Refresh Tokens

refresh_tokens

Refresh token adapter interface.

Defines the abstract interface for refresh token storage and retrieval. Inherits from BaseTokenAdapter for common token operations.

Classes

RefreshTokenAdapter

Bases: BaseTokenAdapter[Any]

Abstract base class for refresh token database operations.

Inherits from BaseTokenAdapter and provides backward compatibility with the get_active() and revoke() methods.

Functions
get_active 
get_active(*, token_hash: str) -> Any

Get an active (not revoked) refresh token.

This is a convenience method that calls get_valid().

Parameters:

Name Type Description Default
token_hash str

Hashed token to look up

 required

Returns:

Type Description
Any

Token record if found and active, None otherwise
Source code in fastauth/adapters/base/refresh_tokens.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
def get_active(self, *, token_hash: str) -> Any:
    """
    Get an active (not revoked) refresh token.

    This is a convenience method that calls get_valid().

    Args:
        token_hash: Hashed token to look up

    Returns:
        Token record if found and active, None otherwise
    """
    return self.get_valid(token_hash=token_hash)
revoke 
revoke(*, token_hash: str) -> None

Revoke a refresh token.

This is a convenience method that calls invalidate().

Parameters:

Name Type Description Default
token_hash str

Hashed token to revoke

 required
Source code in fastauth/adapters/base/refresh_tokens.py 
34
35
36
37
38
39
40
41
42
43
def revoke(self, *, token_hash: str) -> None:
    """
    Revoke a refresh token.

    This is a convenience method that calls invalidate().

    Args:
        token_hash: Hashed token to revoke
    """
    self.invalidate(token_hash=token_hash)