# jwt - pydoc - phpman > **TLDR:** Work with JSON Web Tokens (JWTs). > - Decode a JWT: `jwt decode {{jwt_string}}` - Decode a JWT as a JSON string: `jwt decode {{-j|--json}} {{jwt_string}}` - Encode a JSON string to a JWT: `jwt encode {{-A|--alg}} {{HS256}} {{-S|--secret}} {{1234567890}} '{{json_string}}'` - Encode key pair payload to JWT: `jwt encode {{-A|--alg}} {{HS256}} {{-S|--secret}} {{1234567890}} {{-P|--payload}} {{key=value}}` *Source: tldr-pages* --- Help on package jwt: ## NAME jwt - JSON Web Token implementation in Python <> ## PACKAGE CONTENTS algorithms api_jwk api_jws api_jwt exceptions help jwks_client utils ## CLASSES builtins.Exception(builtins.BaseException) 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 builtins.object jwt.api_jwk.PyJWK jwt.api_jwk.PyJWKSet jwt.api_jws.PyJWS jwt.api_jwt.PyJWT jwt.jwks_client.PyJWKClient ### class DecodeError | Method resolution order: | DecodeError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class ExpiredSignatureError | Method resolution order: | ExpiredSignatureError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class ImmatureSignatureError | Method resolution order: | ImmatureSignatureError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class InvalidAlgorithmError | Method resolution order: | InvalidAlgorithmError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class InvalidAudienceError | Method resolution order: | InvalidAudienceError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class InvalidIssuedAtError | Method resolution order: | InvalidIssuedAtError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class InvalidIssuerError | Method resolution order: | InvalidIssuerError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class InvalidKeyError | Method resolution order: | InvalidKeyError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class InvalidSignatureError | Method resolution order: | InvalidSignatureError | DecodeError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class InvalidTokenError | Method resolution order: | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class MissingRequiredClaimError | MissingRequiredClaimError(claim) | | Method resolution order: | MissingRequiredClaimError | InvalidTokenError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, claim) | Initialize self. See help(type(self)) for accurate signature. | | __str__(self) | Return str(self). | | ---------------------------------------------------------------------- | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class PyJWK | PyJWK(jwk_data, algorithm=None) | | Methods defined here: | | __init__(self, jwk_data, algorithm=None) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods defined here: | | from_dict(obj, algorithm=None) | | from_json(data, algorithm=None) | | ---------------------------------------------------------------------- | Readonly properties defined here: | | key_id | | key_type | | public_key_use | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) ### class PyJWKClient | PyJWKClient(uri: str, cache_keys: bool = True, max_cached_keys: int = 16) | | Methods defined here: | | __init__(self, uri: str, cache_keys: bool = True, max_cached_keys: int = 16) | Initialize self. See help(type(self)) for accurate signature. | | 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] | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) ### class PyJWKClientError | Method resolution order: | PyJWKClientError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class PyJWKError | Method resolution order: | PyJWKError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class PyJWKSet | PyJWKSet(keys) | | Methods defined here: | | __init__(self, keys) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods defined here: | | from_dict(obj) | | from_json(data) | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) ### class PyJWKSetError | Method resolution order: | PyJWKSetError | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from PyJWTError: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ### class PyJWS | PyJWS(algorithms=None, options=None) | | Methods defined here: | | __init__(self, algorithms=None, options=None) | Initialize self. See help(type(self)) for accurate signature. | | decode(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, **kwargs) -> str | | decode_complete(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, **kwargs) -> Dict[str, Any] | | encode(self, payload: bytes, key: str, algorithm: Optional[str] = 'HS256', headers: Optional[Dict] = None, json_encoder: Optional[Type[json.encoder.JSONEncoder]] = None) -> str | | get_algorithms(self) | Returns a list of supported values for the 'alg' parameter. | | get_unverified_header(self, jwt) | Returns back the JWT header parameters as a dict() | | Note: The signature is not verified so the header parameters | should not be fully trusted until signature verification is complete | | register_algorithm(self, alg_id, alg_obj) | Registers a new Algorithm for use when creating and verifying tokens. | | unregister_algorithm(self, alg_id) | Unregisters an Algorithm for use when creating and verifying tokens | Throws KeyError if algorithm is not registered. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | header_typ = 'JWT' ### class PyJWT | PyJWT(options=None) | | Methods defined here: | | __init__(self, options=None) | Initialize self. See help(type(self)) for accurate signature. | | decode(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, **kwargs) -> Dict[str, Any] | | decode_complete(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, **kwargs) -> Dict[str, Any] | | encode(self, payload: Dict[str, Any], key: str, algorithm: Optional[str] = 'HS256', headers: Optional[Dict] = None, json_encoder: Optional[Type[json.encoder.JSONEncoder]] = None) -> str | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) ### class PyJWTError | Base class for all exceptions | | Method resolution order: | PyJWTError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ## FUNCTIONS ### decode ### encode ### get_unverified_header Returns back the JWT header parameters as a dict() Note: The signature is not verified so the header parameters should not be fully trusted until signature verification is complete ### register_algorithm Registers a new Algorithm for use when creating and verifying tokens. ### unregister_algorithm Unregisters an Algorithm for use when creating and verifying tokens Throws KeyError if algorithm is not registered. ## DATA __all__ = ['PyJWS', 'PyJWT', 'PyJWKClient', 'PyJWK', 'PyJWKSet', 'deco... __copyright__ = 'Copyright 2015-2020 José Padilla' __description__ = 'JSON Web Token implementation in Python' __email__ = '' __license__ = 'MIT' __title__ = 'PyJWT' __uri__ = '' __url__ = '' ## VERSION 2.3.0 ## AUTHOR José Padilla ## FILE /usr/lib/python3/dist-packages/jwt/__init__.py