Skip to content

Commit

Permalink
Added section to usage docs for jwt.get_unverified_header() (#350)
Browse files Browse the repository at this point in the history
  • Loading branch information
acdebaca authored and jpadilla committed May 19, 2018
1 parent aed7305 commit c4a4fb6
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,20 @@ the integrity or authenticity of the claimset cannot be trusted.
>>jwt.decode(encoded, verify=False)
{u'some': u'payload'}
Reading Headers without Validation
----------------------------------

Some APIs require you to read a JWT header without validation. For example,
in situations where the token issuer uses multiple keys and you have no
way of knowing in advance which one of the issuer's public keys or shared
secrets to use for validation, the issuer may include an identifier for the
key in the header.

.. code-block:: python
>>jwt.get_unverified_header(encoded)
{u'alg': u'RS256', u'typ': u'JWT', u'kid': u'key-id-12345...'}
Registered Claim Names
----------------------

Expand Down

0 comments on commit c4a4fb6

Please sign in to comment.