{
    "content": [
        {
            "type": "text",
            "text": "# jwt (pydoc)\n\n## TLDR\n\n> Work with JSON Web Tokens (JWTs).\n\n- Decode a JWT:\n  `jwt decode {{jwt_string}}`\n- Decode a JWT as a JSON string:\n  `jwt decode {{-j|--json}} {{jwt_string}}`\n- Encode a JSON string to a JWT:\n  `jwt encode {{-A|--alg}} {{HS256}} {{-S|--secret}} {{1234567890}} '{{json_string}}'`\n- Encode key pair payload to JWT:\n  `jwt encode {{-A|--alg}} {{HS256}} {{-S|--secret}} {{1234567890}} {{-P|--payload}} {{key=value}}`\n\n*Source: tldr-pages*\n\n---\n\n**Summary:** jwt - JSON Web Token implementation in Python <https://pyjwt.readthedocs.io>\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **PACKAGE CONTENTS** (9 lines)\n- **CLASSES** (23 lines) — 20 subsections\n  - class DecodeError (69 lines)\n  - class ExpiredSignatureError (69 lines)\n  - class ImmatureSignatureError (69 lines)\n  - class InvalidAlgorithmError (69 lines)\n  - class InvalidAudienceError (69 lines)\n  - class InvalidIssuedAtError (69 lines)\n  - class InvalidIssuerError (69 lines)\n  - class InvalidKeyError (68 lines)\n  - class InvalidSignatureError (70 lines)\n  - class InvalidTokenError (68 lines)\n  - class MissingRequiredClaimError (71 lines)\n  - class PyJWK (32 lines)\n  - class PyJWKClient (26 lines)\n  - class PyJWKClientError (68 lines)\n  - class PyJWKError (68 lines)\n  - class PyJWKSet (23 lines)\n  - class PyJWKSetError (68 lines)\n  - class PyJWS (43 lines)\n  - class PyJWT (22 lines)\n  - class PyJWTError (69 lines)\n- **FUNCTIONS** (1 lines) — 5 subsections\n  - decode (1 lines)\n  - encode (1 lines)\n  - get_unverified_header (5 lines)\n  - register_algorithm (2 lines)\n  - unregister_algorithm (3 lines)\n- **DATA** (9 lines)\n- **VERSION** (2 lines)\n- **AUTHOR** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\njwt - JSON Web Token implementation in Python <https://pyjwt.readthedocs.io>\n\n### PACKAGE CONTENTS\n\nalgorithms\napijwk\napijws\napijwt\nexceptions\nhelp\njwksclient\nutils\n\n### CLASSES\n\nbuiltins.Exception(builtins.BaseException)\njwt.exceptions.PyJWTError\njwt.exceptions.InvalidKeyError\njwt.exceptions.InvalidTokenError\njwt.exceptions.DecodeError\njwt.exceptions.InvalidSignatureError\njwt.exceptions.ExpiredSignatureError\njwt.exceptions.ImmatureSignatureError\njwt.exceptions.InvalidAlgorithmError\njwt.exceptions.InvalidAudienceError\njwt.exceptions.InvalidIssuedAtError\njwt.exceptions.InvalidIssuerError\njwt.exceptions.MissingRequiredClaimError\njwt.exceptions.PyJWKClientError\njwt.exceptions.PyJWKError\njwt.exceptions.PyJWKSetError\nbuiltins.object\njwt.apijwk.PyJWK\njwt.apijwk.PyJWKSet\njwt.apijws.PyJWS\njwt.apijwt.PyJWT\njwt.jwksclient.PyJWKClient\n\n#### class DecodeError\n\n|  Method resolution order:\n|      DecodeError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class ExpiredSignatureError\n\n|  Method resolution order:\n|      ExpiredSignatureError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class ImmatureSignatureError\n\n|  Method resolution order:\n|      ImmatureSignatureError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class InvalidAlgorithmError\n\n|  Method resolution order:\n|      InvalidAlgorithmError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class InvalidAudienceError\n\n|  Method resolution order:\n|      InvalidAudienceError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class InvalidIssuedAtError\n\n|  Method resolution order:\n|      InvalidIssuedAtError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class InvalidIssuerError\n\n|  Method resolution order:\n|      InvalidIssuerError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class InvalidKeyError\n\n|  Method resolution order:\n|      InvalidKeyError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class InvalidSignatureError\n\n|  Method resolution order:\n|      InvalidSignatureError\n|      DecodeError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class InvalidTokenError\n\n|  Method resolution order:\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class MissingRequiredClaimError\n\n|  MissingRequiredClaimError(claim)\n|\n|  Method resolution order:\n|      MissingRequiredClaimError\n|      InvalidTokenError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, claim)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  str(self)\n|      Return str(self).\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class PyJWK\n\n|  PyJWK(jwkdata, algorithm=None)\n|\n|  Methods defined here:\n|\n|  init(self, jwkdata, algorithm=None)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  fromdict(obj, algorithm=None)\n|\n|  fromjson(data, algorithm=None)\n|\n|  ----------------------------------------------------------------------\n|  Readonly properties defined here:\n|\n|  keyid\n|\n|  keytype\n|\n|  publickeyuse\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n#### class PyJWKClient\n\n|  PyJWKClient(uri: str, cachekeys: bool = True, maxcachedkeys: int = 16)\n|\n|  Methods defined here:\n|\n|  init(self, uri: str, cachekeys: bool = True, maxcachedkeys: int = 16)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  fetchdata(self) -> Any\n|\n|  getjwkset(self) -> jwt.apijwk.PyJWKSet\n|\n|  getsigningkey(self, kid: str) -> jwt.apijwk.PyJWK\n|\n|  getsigningkeyfromjwt(self, token: str) -> jwt.apijwk.PyJWK\n|\n|  getsigningkeys(self) -> List[jwt.apijwk.PyJWK]\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n#### class PyJWKClientError\n\n|  Method resolution order:\n|      PyJWKClientError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class PyJWKError\n\n|  Method resolution order:\n|      PyJWKError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class PyJWKSet\n\n|  PyJWKSet(keys)\n|\n|  Methods defined here:\n|\n|  init(self, keys)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  fromdict(obj)\n|\n|  fromjson(data)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n#### class PyJWKSetError\n\n|  Method resolution order:\n|      PyJWKSetError\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors inherited from PyJWTError:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n#### class PyJWS\n\n|  PyJWS(algorithms=None, options=None)\n|\n|  Methods defined here:\n|\n|  init(self, algorithms=None, options=None)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  decode(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, kwargs) -> str\n|\n|  decodecomplete(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, kwargs) -> Dict[str, Any]\n|\n|  encode(self, payload: bytes, key: str, algorithm: Optional[str] = 'HS256', headers: Optional[Dict] = None, jsonencoder: Optional[Type[json.encoder.JSONEncoder]] = None) -> str\n|\n|  getalgorithms(self)\n|      Returns a list of supported values for the 'alg' parameter.\n|\n|  getunverifiedheader(self, jwt)\n|      Returns back the JWT header parameters as a dict()\n|\n|      Note: The signature is not verified so the header parameters\n|      should not be fully trusted until signature verification is complete\n|\n|  registeralgorithm(self, algid, algobj)\n|      Registers a new Algorithm for use when creating and verifying tokens.\n|\n|  unregisteralgorithm(self, algid)\n|      Unregisters an Algorithm for use when creating and verifying tokens\n|      Throws KeyError if algorithm is not registered.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  headertyp = 'JWT'\n\n#### class PyJWT\n\n|  PyJWT(options=None)\n|\n|  Methods defined here:\n|\n|  init(self, options=None)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  decode(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, kwargs) -> Dict[str, Any]\n|\n|  decodecomplete(self, jwt: str, key: str = '', algorithms: List[str] = None, options: Dict = None, kwargs) -> Dict[str, Any]\n|\n|  encode(self, payload: Dict[str, Any], key: str, algorithm: Optional[str] = 'HS256', headers: Optional[Dict] = None, jsonencoder: Optional[Type[json.encoder.JSONEncoder]] = None) -> str\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n#### class PyJWTError\n\n|  Base class for all exceptions\n|\n|  Method resolution order:\n|      PyJWTError\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Data descriptors defined here:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.Exception:\n|\n|  init(self, /, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  repr(self, /)\n|      Return repr(self).\n|\n|  setattr(self, name, value, /)\n|      Implement setattr(self, name, value).\n|\n|  setstate(...)\n|\n|  str(self, /)\n|      Return str(self).\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n\n### FUNCTIONS\n\n#### decode\n\n#### encode\n\n#### get_unverified_header\n\nReturns back the JWT header parameters as a dict()\n\nNote: The signature is not verified so the header parameters\nshould not be fully trusted until signature verification is complete\n\n#### register_algorithm\n\nRegisters a new Algorithm for use when creating and verifying tokens.\n\n#### unregister_algorithm\n\nUnregisters an Algorithm for use when creating and verifying tokens\nThrows KeyError if algorithm is not registered.\n\n### DATA\n\nall = ['PyJWS', 'PyJWT', 'PyJWKClient', 'PyJWK', 'PyJWKSet', 'deco...\ncopyright = 'Copyright 2015-2020 José Padilla'\ndescription = 'JSON Web Token implementation in Python'\nemail = 'hello@jpadilla.com'\nlicense = 'MIT'\ntitle = 'PyJWT'\nuri = 'https://pyjwt.readthedocs.io'\nurl = 'https://pyjwt.readthedocs.io'\n\n### VERSION\n\n2.3.0\n\n### AUTHOR\n\nJosé Padilla\n\n### FILE\n\n/usr/lib/python3/dist-packages/jwt/init.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "jwt",
        "section": "",
        "mode": "pydoc",
        "summary": "jwt - JSON Web Token implementation in Python <https://pyjwt.readthedocs.io>",
        "synopsis": null,
        "tldr_summary": "Work with JSON Web Tokens (JWTs).",
        "tldr_examples": [
            {
                "description": "Decode a JWT",
                "command": "jwt decode {{jwt_string}}"
            },
            {
                "description": "Decode a JWT as a JSON string",
                "command": "jwt decode {{-j|--json}} {{jwt_string}}"
            },
            {
                "description": "Encode a JSON string to a JWT",
                "command": "jwt encode {{-A|--alg}} {{HS256}} {{-S|--secret}} {{1234567890}} '{{json_string}}'"
            },
            {
                "description": "Encode key pair payload to JWT",
                "command": "jwt encode {{-A|--alg}} {{HS256}} {{-S|--secret}} {{1234567890}} {{-P|--payload}} {{key=value}}"
            }
        ],
        "tldr_source": "official",
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "PACKAGE CONTENTS",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "CLASSES",
                "lines": 23,
                "subsections": [
                    {
                        "name": "class DecodeError",
                        "lines": 69
                    },
                    {
                        "name": "class ExpiredSignatureError",
                        "lines": 69
                    },
                    {
                        "name": "class ImmatureSignatureError",
                        "lines": 69
                    },
                    {
                        "name": "class InvalidAlgorithmError",
                        "lines": 69
                    },
                    {
                        "name": "class InvalidAudienceError",
                        "lines": 69
                    },
                    {
                        "name": "class InvalidIssuedAtError",
                        "lines": 69
                    },
                    {
                        "name": "class InvalidIssuerError",
                        "lines": 69
                    },
                    {
                        "name": "class InvalidKeyError",
                        "lines": 68
                    },
                    {
                        "name": "class InvalidSignatureError",
                        "lines": 70
                    },
                    {
                        "name": "class InvalidTokenError",
                        "lines": 68
                    },
                    {
                        "name": "class MissingRequiredClaimError",
                        "lines": 71
                    },
                    {
                        "name": "class PyJWK",
                        "lines": 32
                    },
                    {
                        "name": "class PyJWKClient",
                        "lines": 26
                    },
                    {
                        "name": "class PyJWKClientError",
                        "lines": 68
                    },
                    {
                        "name": "class PyJWKError",
                        "lines": 68
                    },
                    {
                        "name": "class PyJWKSet",
                        "lines": 23
                    },
                    {
                        "name": "class PyJWKSetError",
                        "lines": 68
                    },
                    {
                        "name": "class PyJWS",
                        "lines": 43
                    },
                    {
                        "name": "class PyJWT",
                        "lines": 22
                    },
                    {
                        "name": "class PyJWTError",
                        "lines": 69
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "decode",
                        "lines": 1
                    },
                    {
                        "name": "encode",
                        "lines": 1
                    },
                    {
                        "name": "get_unverified_header",
                        "lines": 5
                    },
                    {
                        "name": "register_algorithm",
                        "lines": 2
                    },
                    {
                        "name": "unregister_algorithm",
                        "lines": 3
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}