Skip to content

AuthXDependency#

authx.dependencies.AuthXDependency #

AuthXDependency(_from, request, response)

Bases: Generic[T]

PARAMETER DESCRIPTION
_from

TYPE: AuthX[T]

request

TYPE: Request

response

TYPE: Response

Source code in authx/dependencies.py 
12
13
14
15
16
17
18
19
20
def __init__(
    self,
    _from: "AuthX[T]",
    request: Request,
    response: Response,
) -> None:
    self._response = response
    self._request = request
    self._security = _from

request property #

request

response property #

response

create_access_token #

create_access_token(uid, fresh=False, headers=None, expiry=None, data=None, audience=None, *args, **kwargs)
PARAMETER DESCRIPTION
uid

TYPE: str

fresh

TYPE: bool DEFAULT: False

headers

TYPE: Optional[Dict[str, Any]] DEFAULT: None

expiry

TYPE: Optional[DateTimeExpression] DEFAULT: None

data

TYPE: Optional[Dict[str, Any]] DEFAULT: None

audience

TYPE: Optional[StringOrSequence] DEFAULT: None

*args

TYPE: Any DEFAULT: ()

**kwargs

TYPE: Any DEFAULT: {}

Source code in authx/dependencies.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def create_access_token(
    self,
    uid: str,
    fresh: bool = False,
    headers: Optional[Dict[str, Any]] = None,
    expiry: Optional[DateTimeExpression] = None,
    data: Optional[Dict[str, Any]] = None,
    audience: Optional[StringOrSequence] = None,
    *args: Any,
    **kwargs: Any,
) -> str:
    return self._security.create_access_token(
        uid, fresh, headers, expiry, data, audience, *args, **kwargs
    )

create_refresh_token #

create_refresh_token(uid, headers=None, expiry=None, data=None, audience=None, *args, **kwargs)
PARAMETER DESCRIPTION
uid

TYPE: str

headers

TYPE: Optional[Dict[str, Any]] DEFAULT: None

expiry

TYPE: Optional[DateTimeExpression] DEFAULT: None

data

TYPE: Optional[Dict[str, Any]] DEFAULT: None

audience

TYPE: Optional[StringOrSequence] DEFAULT: None

*args

TYPE: Any DEFAULT: ()

**kwargs

TYPE: Any DEFAULT: {}

Source code in authx/dependencies.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
def create_refresh_token(
    self,
    uid: str,
    headers: Optional[Dict[str, Any]] = None,
    expiry: Optional[DateTimeExpression] = None,
    data: Optional[Dict[str, Any]] = None,
    audience: Optional[StringOrSequence] = None,
    *args: Any,
    **kwargs: Any,
) -> str:
    return self._security.create_refresh_token(
        uid, headers, expiry, data, audience, *args, **kwargs
    )

set_access_cookies #

set_access_cookies(token, response=None, max_age=None)
PARAMETER DESCRIPTION
token

TYPE: str

response

TYPE: Optional[Response] DEFAULT: None

max_age

TYPE: Optional[int] DEFAULT: None

Source code in authx/dependencies.py 
59
60
61
62
63
64
65
66
67
def set_access_cookies(
    self,
    token: str,
    response: Optional[Response] = None,
    max_age: Optional[int] = None,
) -> None:
    self._security.set_access_cookies(
        token=token, response=(response or self._response), max_age=max_age
    )

set_refresh_cookies #

set_refresh_cookies(token, response=None, max_age=None)
PARAMETER DESCRIPTION
token

TYPE: str

response

TYPE: Optional[Response] DEFAULT: None

max_age

TYPE: Optional[int] DEFAULT: None

Source code in authx/dependencies.py 
69
70
71
72
73
74
75
76
77
def set_refresh_cookies(
    self,
    token: str,
    response: Optional[Response] = None,
    max_age: Optional[int] = None,
) -> None:
    self._security.set_refresh_cookies(
        token=token, response=(response or self._response), max_age=max_age
    )

unset_access_cookies #

unset_access_cookies(response=None)
PARAMETER DESCRIPTION
response

TYPE: Optional[Response] DEFAULT: None

Source code in authx/dependencies.py 
79
80
def unset_access_cookies(self, response: Optional[Response] = None) -> None:
    self._security.unset_access_cookies(response=(response or self._response))

unset_refresh_cookies #

unset_refresh_cookies(response=None)
PARAMETER DESCRIPTION
response

TYPE: Optional[Response] DEFAULT: None

Source code in authx/dependencies.py 
82
83
def unset_refresh_cookies(self, response: Optional[Response] = None) -> None:
    self._security.unset_access_cookies(response=(response or self._response))

unset_cookies #

unset_cookies(response=None)
PARAMETER DESCRIPTION
response

TYPE: Optional[Response] DEFAULT: None

Source code in authx/dependencies.py 
85
86
def unset_cookies(self, response: Optional[Response] = None) -> None:
    self._security.unset_cookies(response=(response or self._response))

get_current_subject async #

get_current_subject()
Source code in authx/dependencies.py 
88
89
async def get_current_subject(self) -> Optional[T]:
    return await self._security.get_current_subject(request=self._request)