1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
API Reference
=============
.. module:: jwt
.. autofunction:: encode(payload, key, algorithm="HS256", headers=None, json_encoder=None) -> str
.. autofunction:: decode(jwt, key="", algorithms=None, options=None, audience=None, issuer=None, leeway=0) -> dict[str, typing.Any]
.. autoclass:: PyJWK
:class-doc-from: init
:members:
.. property:: algorithm_name
:type: str
The name of the algorithm used by the key.
.. property:: Algorithm
The :py:class:`Algorithm` class associated with the key.
.. module:: jwt.api_jwt
.. autofunction:: decode_complete(jwt, key="", algorithms=None, options=None, audience=None, issuer=None, leeway=0) -> dict[str, typing.Any]
.. note:: TODO: Finish documenting PyJWS class
.. module:: jwt.api_jws
.. autoclass:: jwt.api_jws.PyJWS
:members:
Algorithms
----------
.. automodule:: jwt.algorithms
:members: Algorithm, AllowedPrivateKeys, AllowedPublicKeys
Types
----------
.. module:: jwt.types
:synopsis: Type validation used in the JWT API
.. autoclass:: jwt.types.SigOptions
:members:
:undoc-members:
.. autoclass:: jwt.types.Options
:members:
:undoc-members:
Warnings
----------
.. automodule:: jwt.warnings
:members:
:show-inheritance:
Exceptions
----------
.. automodule:: jwt.exceptions
:members:
:inherited-members:
:show-inheritance:
|
