pydoc > jwt

man perldoc info pydoc3 ri search

📛 NAME

jwt - JSON Web Token implementation in Python <https://pyjwt.readthedocs.io>

🚀 Quick Reference

Use Case	Command	Description
🔑 Encode a JWT	jwt.encode(payload, key, algorithm='HS256')	Create a signed JWT token
🔓 Decode a JWT	jwt.decode(token, key, algorithms=['HS256'])	Verify and decode a JWT token
📄 Get unverified header	jwt.get_unverified_header(token)	Extract header without verification
🔗 Fetch signing key from JWKS	PyJWKClient(uri).get_signing_key_from_jwt(token)	Retrieve key from JWK Set
⚙️ Register custom algorithm	jwt.register_algorithm(alg_id, alg_obj)	Add a new algorithm for signing

📦 PACKAGE CONTENTS

• algorithms
• api_jwk
• api_jws
• api_jwt
• exceptions
• help
• jwks_client
• utils

📚 CLASSES

🔍 Exception Hierarchy

• builtins.Exception
  • jwt.exceptions.PyJWTError
    • jwt.exceptions.InvalidKeyError
    • jwt.exceptions.InvalidTokenError
      • jwt.exceptions.DecodeError
        • jwt.exceptions.InvalidSignatureError
      • jwt.exceptions.ExpiredSignatureError
      • jwt.exceptions.ImmatureSignatureError
      • jwt.exceptions.InvalidAlgorithmError
      • jwt.exceptions.InvalidAudienceError
      • jwt.exceptions.InvalidIssuedAtError
      • jwt.exceptions.InvalidIssuerError
      • jwt.exceptions.MissingRequiredClaimError
    • jwt.exceptions.PyJWKClientError
    • jwt.exceptions.PyJWKError
    • jwt.exceptions.PyJWKSetError

🔧 Exception Classes Detail

All exception classes inherit from PyJWTError and share the standard methods from builtins.Exception and builtins.BaseException (e.g., __init__, __str__, with_traceback). Only unique or overridden members are listed below.

📌 PyJWTError

Base class for all exceptions

• __weakref__ — list of weak references to the object (if defined)

📌 InvalidKeyError

Inherits from PyJWTError

📌 InvalidTokenError

Inherits from PyJWTError

📌 DecodeError

Inherits from InvalidTokenError

📌 InvalidSignatureError

Inherits from DecodeError

📌 ExpiredSignatureError

Inherits from InvalidTokenError

📌 ImmatureSignatureError

Inherits from InvalidTokenError

📌 InvalidAlgorithmError

Inherits from InvalidTokenError

📌 InvalidAudienceError

Inherits from InvalidTokenError

📌 InvalidIssuedAtError

Inherits from InvalidTokenError

📌 InvalidIssuerError

Inherits from InvalidTokenError

📌 MissingRequiredClaimError

Inherits from InvalidTokenError

• __init__(self, claim) — Initialize self
• __str__(self) — Return str(self)

📌 PyJWKClientError

Inherits from PyJWTError

📌 PyJWKError

Inherits from PyJWTError

📌 PyJWKSetError

Inherits from PyJWTError

🔧 Non-Exception Classes

📌 PyJWK

PyJWK(jwk_data, algorithm=None)

• __init__(self, jwk_data, algorithm=None)
• from_dict(obj, algorithm=None) — static method
• from_json(data, algorithm=None) — static method
• key_id — readonly property
• key_type — readonly property
• public_key_use — readonly property
• __dict__, __weakref__

📌 PyJWKClient

PyJWKClient(uri: str, cache_keys: bool = True, max_cached_keys: int = 16)

• __init__(self, uri, cache_keys=True, max_cached_keys=16)
• fetch_data(self) -> Any
• get_jwk_set(self) -> jwt.api_jwk.PyJWKSet
• get_signing_key(self, kid: str) -> jwt.api_jwk.PyJWK
• get_signing_key_from_jwt(self, token: str) -> jwt.api_jwk.PyJWK
• get_signing_keys(self) -> List[jwt.api_jwk.PyJWK]
• __dict__, __weakref__

📌 PyJWKSet

PyJWKSet(keys)

• __init__(self, keys)
• from_dict(obj) — static method
• from_json(data) — static method
• __dict__, __weakref__

📌 PyJWS

PyJWS(algorithms=None, options=None)

• header_typ = 'JWT'
• __init__(self, algorithms=None, options=None)
• decode(self, jwt, key='', algorithms=None, options=None, **kwargs) -> str
• decode_complete(self, jwt, key='', algorithms=None, options=None, **kwargs) -> Dict[str, Any]
• encode(self, payload, key, algorithm='HS256', headers=None, json_encoder=None) -> str
• get_algorithms(self) — Returns a list of supported values for the 'alg' parameter.
• get_unverified_header(self, jwt) — Returns the JWT header parameters as a dict() (signature not verified)
• register_algorithm(self, alg_id, alg_obj) — Registers a new Algorithm
• unregister_algorithm(self, alg_id) — Unregisters an Algorithm (throws KeyError)
• __dict__, __weakref__

📌 PyJWT

PyJWT(options=None)

• __init__(self, options=None)
• decode(self, jwt, key='', algorithms=None, options=None, **kwargs) -> Dict[str, Any]
• decode_complete(self, jwt, key='', algorithms=None, options=None, **kwargs) -> Dict[str, Any]
• encode(self, payload, key, algorithm='HS256', headers=None, json_encoder=None) -> str
• __dict__, __weakref__

⚡ FUNCTIONS

• decode(jwt, key='', algorithms=None, options=None, **kwargs) -> Dict[str, Any] — method of jwt.api_jwt.PyJWT instance
• encode(payload, key, algorithm='HS256', headers=None, json_encoder=None) -> str — method of jwt.api_jwt.PyJWT instance
• get_unverified_header(jwt) — method of jwt.api_jws.PyJWS instance. Returns the JWT header parameters as a dict() (signature not verified)
• register_algorithm(alg_id, alg_obj) — method of jwt.api_jws.PyJWS instance. Registers a new Algorithm
• unregister_algorithm(alg_id) — method of jwt.api_jws.PyJWS instance. Unregisters an Algorithm (throws KeyError)

📊 DATA

• __all__ = ['PyJWS', 'PyJWT', 'PyJWKClient', 'PyJWK', 'PyJWKSet', 'deco...']
• __copyright__ = 'Copyright 2015-2020 José Padilla'
• __description__ = 'JSON Web Token implementation in Python'
• __email__ = 'hello AT jpadilla.com'
• __license__ = 'MIT'
• __title__ = 'PyJWT'
• __uri__ = 'https://pyjwt.readthedocs.io'
• __url__ = 'https://pyjwt.readthedocs.io'

📦 VERSION

2.3.0

✍️ AUTHOR

José Padilla

📁 FILE

/usr/lib/python3/dist-packages/jwt/__init__.py

📛 NAME 🚀 Quick Reference 📦 PACKAGE CONTENTS 📚 CLASSES ⚡ FUNCTIONS 📊 DATA 📦 VERSION ✍️ AUTHOR 📁 FILE