@@ -65,33 +65,47 @@ In here you will find the API for everything exposed in this extension.
65
65
* **user_claims**: Custom claims to include in this token. This data must be dictionary
66
66
* Returns: An encoded refresh token
67
67
68
- ** set_access_cookies** (encoded_access_token, max_age=None)
68
+ ** set_access_cookies** (encoded_access_token, response=None, max_age=None)
69
69
: * Configures the response to set access token in a cookie. This will also set the CSRF double submit values
70
70
in a separate cookie.*
71
71
72
72
* Parameters:
73
73
* **encoded_access_token**: The encoded access token to set in the cookies
74
+ * **response**: The FastAPI response object to set the access cookies in
74
75
* **max_age**: The max age of the cookie value should be `integer` the number of seconds
75
76
* Returns: None
76
77
77
- ** set_refresh_cookies** (encoded_refresh_token, max_age=None)
78
+ ** set_refresh_cookies** (encoded_refresh_token, response=None, max_age=None)
78
79
: * Configures the response to set refresh token in a cookie. This will also set the CSRF double submit values
79
80
in a separate cookie.*
80
81
81
82
* Parameters:
82
83
* **encoded_refresh_token**: The encoded refresh token to set in the cookies
84
+ * **response**: The FastAPI response object to set the refresh cookies in
83
85
* **max_age**: The max age of the cookie value should be `integer` the number of seconds
84
86
* Returns: None
85
87
86
- ** unset_jwt_cookies** ()
88
+ ** unset_jwt_cookies** (response=None )
87
89
: * Unset (delete) all jwt stored in a cookies.*
88
90
89
- ** unset_access_cookies** ()
91
+ * Parameters:
92
+ * **response**: The FastAPI response object to delete the JWT cookies in
93
+ * Returns: None
94
+
95
+ ** unset_access_cookies** (response=None)
90
96
: * Remove access token and access CSRF double submit from the response cookies.*
91
97
92
- ** unset_refresh_cookies** ()
98
+ * Parameters:
99
+ * **response**: The FastAPI response object to delete the access cookies in
100
+ * Returns: None
101
+
102
+ ** unset_refresh_cookies** (response=None)
93
103
: * Remove refresh token and refresh CSRF double submit from the response cookies.*
94
104
105
+ * Parameters:
106
+ * **response**: The FastAPI response object to delete the refresh cookies in
107
+ * Returns: None
108
+
95
109
** get_raw_jwt** ()
96
110
: * This will return the python dictionary which has all of the claims of the JWT that is accessing the endpoint.
97
111
If no JWT is currently present, return ` None ` instead.*
0 commit comments