diff options
author | Wouter Bolsterlee <wouter@intelworks.com> | 2015-01-06 17:47:45 +0100 |
---|---|---|
committer | Wouter Bolsterlee <wouter@intelworks.com> | 2015-01-06 17:47:45 +0100 |
commit | 183002ef46d3acc50e49932f72a9ab3b78603163 (patch) | |
tree | 49829d3ac508c6d84903660bb64c486c4a6d56e3 | |
parent | 4d28e6a7dded4b6cbb04f834bd082b43d0fb63ca (diff) | |
download | pyjwt-183002ef46d3acc50e49932f72a9ab3b78603163.tar.gz |
Mention InvalidIssuerError and InvalidAudienceError in README
-rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -197,6 +197,9 @@ token = jwt.encode(payload, 'secret') decoded = jwt.decode(token, 'secret', issuer='urn:foo') ``` +If the issuer claim is incorrect, `jwt.InvalidIssuerError` will be raised. + + ### Audience Claim > The aud (audience) claim identifies the recipients that the JWT is intended for. Each principal intended to process the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in the aud claim when this claim is present, then the JWT MUST be rejected. In the general case, the aud value is an array of case-sensitive strings, each containing a StringOrURI value. In the special case when the JWT has one audience, the aud value MAY be a single case-sensitive string containing a StringOrURI value. The interpretation of audience values is generally application specific. Use of this claim is OPTIONAL. @@ -214,6 +217,9 @@ token = jwt.encode(payload, 'secret') decoded = jwt.decode(token, 'secret', audience='urn:foo') ``` +If the audience claim is incorrect, `jwt.InvalidAudienceError` will be raised. + + ## License MIT |