diff options
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/api.rst b/docs/api.rst index d23d4bd..f1720b9 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -13,8 +13,9 @@ API Reference * for **asymmetric algorithms**: PEM-formatted private key, a multiline string * for **symmetric algorithms**: plain string, sufficiently long for security - :param str algorithm: algorithm to sign the token with, e.g. ``"ES256"`` - :param dict headers: additional JWT header fields, e.g. ``dict(kid="my-key-id")`` + :param str algorithm: algorithm to sign the token with, e.g. ``"ES256"``. + If ``headers`` includes ``alg``, it will be preferred to this parameter. + :param dict headers: additional JWT header fields, e.g. ``dict(kid="my-key-id")``. :param json.JSONEncoder json_encoder: custom JSON encoder for ``payload`` and ``headers`` :rtype: str :returns: a JSON Web Token |