Skip to content

api.rst

Latest commit

 

History

History
75 lines (51 loc) · 1.54 KB

api.rst

File metadata and controls

75 lines (51 loc) · 1.54 KB

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]


.. autofunction:: decode_complete(jwt, key="", algorithms=None, options=None, verify=None, detached_payload=None, audience=None, issuer=None, subject=None, leeway=0) -> dict[str, typing.Any]


.. autoclass:: PyJWT
    :class-doc-from: init
    :members:


.. 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.


.. autoclass:: PyJWKSet
    :members:


.. autoclass:: PyJWKClient
    :class-doc-from: init
    :members:

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: