Skip to content

Requests

Request objects used throughout the project. 

from aioauth import requests

Post dataclass

Object that contains a client's post request portion of a request. Read more on post requests here.

Source code in aioauth/requests.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@dataclass
class Post:
    """
    Object that contains a client's post request portion of a request.
    Read more on post requests [here](https://en.wikipedia.org/wiki/POST_(HTTP)).
    """

    grant_type: Optional[GrantType] = None
    client_id: Optional[str] = None
    client_secret: Optional[str] = None
    redirect_uri: Optional[str] = None
    scope: str = ""
    username: Optional[str] = None
    password: Optional[str] = None
    refresh_token: Optional[str] = None
    code: Optional[str] = None
    token: Optional[str] = None
    token_type_hint: Optional[TokenType] = None
    code_verifier: Optional[str] = None

Query dataclass

Object that contains a client's query string portion of a request. Read more on query strings here.

Source code in aioauth/requests.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@dataclass
class Query:
    """
    Object that contains a client's query string portion of a request.
    Read more on query strings [here](https://en.wikipedia.org/wiki/Query_string).
    """

    client_id: Optional[str] = None
    redirect_uri: str = ""
    response_type: Optional[str] = None
    state: str = ""
    scope: str = ""
    nonce: Optional[str] = None
    code_challenge_method: Optional[CodeChallengeMethod] = None
    code_challenge: Optional[str] = None
    response_mode: Optional[ResponseMode] = None

Request dataclass

Object that contains a client's complete request.

Source code in aioauth/requests.py 
61
62
63
64
65
66
67
68
69
70
71
@dataclass
class Request:
    """Object that contains a client's complete request."""

    method: RequestMethod
    query: Query = field(default_factory=Query)
    post: Post = field(default_factory=Post)
    headers: HTTPHeaderDict = field(default_factory=HTTPHeaderDict)
    url: str = ""
    settings: Settings = field(default_factory=Settings)
    extra: dict = field(default_factory=dict)