man-pages/man1/pyjwt3.1.html
2021-03-31 01:06:50 +01:00

100 lines
2.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PYJWT</TITLE>
</HEAD><BODY>
<H1>PYJWT</H1>
Section: User Commands (1)<BR>Updated: Dec 2018<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
pyjwt3 - Python implementation of JSON Web Token
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>pyjwt3</B>
[<I>,options/</I>] &lt;command&gt; [<I>,options/</I>] <I>,input/</I>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
Encodes or decodes JSON Web Tokens based on input
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>--version</B><DD>
show program's version number and exit
<DT id="2"><B>-h</B>, <B>--help</B><DD>
show this help message and exit
<DT id="3"><B>-n</B>, <B>--no-verify</B><DD>
ignore signature verification on decode
<DT id="4"><B>--key</B>=<I>,KEY/</I><DD>
set the secret key to sign with
<DT id="5"><B>--alg</B>=<I>,ALG/</I><DD>
set crypto algorithm to sign with. default=HS256
</DL>
<A NAME="lbAF">&nbsp;</A>
<H3>PyJWT subcommands are: <I>,encode/</I> and <I>,decode/</I>.</H3>
<DL COMPACT>
<DT id="6">encode<DD>
use to encode a supplied payload
<DT id="7">decode<DD>
use to decode a supplied JSON web token
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>EXAMPLES</H2>
Decoding:
<P>
pyjwt3 <B>--key</B>=<I>,secret/</I> decode json.web.token
<P>
pyjwt3 decode <B>--no-verify</B> json.web.token
<P>
Encoding requires the key option and takes space separated key/value pairs
separated by equals (=) as input.
<P>
Examples:
<P>
pyjwt3 <B>--key</B>=<I>,secret/</I> encode iss=me exp=1302049071
<P>
pyjwt3 <B>--key</B>=<I>,secret/</I> encode foo=bar exp=+10
<P>
The exp key is special and can take an offset to current Unix time.
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>
Jeff Lindsay &lt;<A HREF="mailto:progrium@gmail.com">progrium@gmail.com</A>&gt;
<P>
This manual page was written by Daniele Tricoli &lt;<A HREF="mailto:eriol@mornie.org">eriol@mornie.org</A>&gt;, for the
Debian project (but may be used by others).
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="10"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="11"><A HREF="#lbAE">OPTIONS</A><DD>
<DL>
<DT id="12"><A HREF="#lbAF">PyJWT subcommands are: <I>,encode/</I> and <I>,decode/</I>.</A><DD>
</DL>
<DT id="13"><A HREF="#lbAG">EXAMPLES</A><DD>
<DT id="14"><A HREF="#lbAH">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:26 GMT, March 31, 2021
</BODY>
</HTML>