File: api.rst

package info (click to toggle)
python-flask-jwt-extended 4.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 592 kB
  • sloc: python: 4,279; makefile: 193; sh: 6
file content (43 lines) | stat: -rw-r--r-- 1,117 bytes parent folder | download | duplicates (2)
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
API Documentation
=================
This is the documentation for all of the API that is exported in this extension.

Configuring Flask-JWT-Extended
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. currentmodule:: flask_jwt_extended

.. module:: flask_jwt_extended

.. autoclass:: JWTManager
   :members:


Verify Tokens in Request
~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: jwt_required

.. autofunction:: verify_jwt_in_request


Utilities
~~~~~~~~~
.. autofunction:: create_access_token
.. autofunction:: create_refresh_token
.. attribute:: current_user

    A LocalProxy for accessing the current user. Roughly equilivant to
    :func:`~flask_jwt_extended.get_current_user`

.. autofunction:: decode_token
.. autofunction:: get_csrf_token
.. autofunction:: get_current_user
.. autofunction:: get_jti
.. autofunction:: get_jwt
.. autofunction:: get_jwt_header
.. autofunction:: get_jwt_identity
.. autofunction:: get_unverified_jwt_headers
.. autofunction:: set_access_cookies
.. autofunction:: set_refresh_cookies
.. autofunction:: unset_access_cookies
.. autofunction:: unset_jwt_cookies
.. autofunction:: unset_refresh_cookies