+{"parents": [], "prev": {"link": "../config/", "title": "auth0_api_python.config"}, "next": {"link": "../errors/", "title": "auth0_api_python.errors"}, "title": "auth0_api_python.encryption", "meta": null, "body": "<section id=\"module-auth0_api_python.encryption\">\n<span id=\"auth0-api-python-encryption\"></span><h1>auth0_api_python.encryption<a class=\"headerlink\" href=\"#module-auth0_api_python.encryption\" title=\"Link to this heading\">\u00b6</a></h1>\n<p>JWE encryption helpers for token store implementations.</p>\n<section id=\"functions\">\n<h2>Functions<a class=\"headerlink\" href=\"#functions\" title=\"Link to this heading\">\u00b6</a></h2>\n<table class=\"autosummary longtable docutils align-default\">\n<tbody>\n<tr class=\"row-odd\"><td><p><a class=\"reference internal\" href=\"#auth0_api_python.encryption.encrypt\" title=\"auth0_api_python.encryption.encrypt\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">encrypt</span></code></a>(\u2192\u00a0str)</p></td>\n<td><p>Encrypt a dict to a compact JWE string. A fresh random kid is generated per call.</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><a class=\"reference internal\" href=\"#auth0_api_python.encryption.decrypt\" title=\"auth0_api_python.encryption.decrypt\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">decrypt</span></code></a>(\u2192\u00a0dict[str,\u00a0Any])</p></td>\n<td><p>Decrypt a compact JWE string back to a dict.</p></td>\n</tr>\n</tbody>\n</table>\n</section>\n<section id=\"module-contents\">\n<h2>Module Contents<a class=\"headerlink\" href=\"#module-contents\" title=\"Link to this heading\">\u00b6</a></h2>\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"auth0_api_python.encryption.encrypt\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">auth0_api_python.encryption.</span></span><span class=\"sig-name descname\"><span class=\"pre\">encrypt</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">payload</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">dict</span><span class=\"p\"><span class=\"pre\">[</span></span><span class=\"pre\">str</span><span class=\"p\"><span class=\"pre\">,</span></span><span class=\"w\"> </span><span class=\"pre\">Any</span><span class=\"p\"><span class=\"pre\">]</span></span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">secret</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">salt</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em><span class=\"sig-paren\">)</span> <span class=\"sig-return\"><span class=\"sig-return-icon\">→</span> <span class=\"sig-return-typehint\"><span class=\"pre\">str</span></span></span><a class=\"headerlink\" href=\"#auth0_api_python.encryption.encrypt\" title=\"Link to this definition\">\u00b6</a></dt>\n<dd><p>Encrypt a dict to a compact JWE string. A fresh random kid is generated per call.</p>\n</dd></dl>\n\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"auth0_api_python.encryption.decrypt\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">auth0_api_python.encryption.</span></span><span class=\"sig-name descname\"><span class=\"pre\">decrypt</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">data</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">secret</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">salt</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em><span class=\"sig-paren\">)</span> <span class=\"sig-return\"><span class=\"sig-return-icon\">→</span> <span class=\"sig-return-typehint\"><span class=\"pre\">dict</span><span class=\"p\"><span class=\"pre\">[</span></span><span class=\"pre\">str</span><span class=\"p\"><span class=\"pre\">,</span></span><span class=\"w\"> </span><span class=\"pre\">Any</span><span class=\"p\"><span class=\"pre\">]</span></span></span></span><a class=\"headerlink\" href=\"#auth0_api_python.encryption.decrypt\" title=\"Link to this definition\">\u00b6</a></dt>\n<dd><p>Decrypt a compact JWE string back to a dict.</p>\n</dd></dl>\n\n</section>\n</section>\n", "metatags": "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n", "rellinks": [["genindex", "General Index", "I", "index"], ["py-modindex", "Python Module Index", "", "modules"], ["auth0_api_python/errors/index", "auth0_api_python.errors", "N", "next"], ["auth0_api_python/config/index", "auth0_api_python.config", "P", "previous"]], "sourcename": "auth0_api_python/encryption/index.rst.txt", "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">auth0_api_python.encryption</a><ul>\n<li><a class=\"reference internal\" href=\"#functions\">Functions</a></li>\n<li><a class=\"reference internal\" href=\"#module-contents\">Module Contents</a><ul>\n<li><a class=\"reference internal\" href=\"#auth0_api_python.encryption.encrypt\"><code class=\"docutils literal notranslate\"><span class=\"pre\">encrypt()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#auth0_api_python.encryption.decrypt\"><code class=\"docutils literal notranslate\"><span class=\"pre\">decrypt()</span></code></a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n", "display_toc": true, "page_source_suffix": ".rst", "current_page_name": "auth0_api_python/encryption/index", "sidebars": ["about.html", "searchfield.html", "navigation.html", "relations.html", "donate.html"], "alabaster_version": "1.0.0", "alabaster_version_info": [1, 0, 0]}
0 commit comments