Fix incorrect require option

jpadilla · Apr 27, 2021 · 692adae · 692adae
1 parent e92ef3d
commit 692adae
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -34,9 +34,8 @@ API Reference
 
     :param dict options: extended decoding and validation options
 
-        * ``require_exp=False`` check that ``exp`` (expiration) claim is present
-        * ``require_iat=False`` check that ``iat`` (issued at) claim is present
-        * ``require_nbf=False`` check that ``nbf`` (not before) claim is present
+        * ``require=[]`` list of claims that must be present. E.g. ``require=["exp", "iat", "nbf"]``.
+            Only verifies that the claims exists. Does NOT verify that the claims are valid. 
         * ``verify_aud=True`` but will be ignored if ``verify_signature`` is ``False``.
             Check that ``aud`` (audience) claim matches ``audience``
         * ``verify_iat=True`` but will be ignored if ``verify_signature`` is ``False``.