<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> <title>music.auth — Mixonomer documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" /> <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/jquery.js"></script> <script src="../_static/underscore.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="../_static/doctools.js"></script> <script src="../_static/sphinx_highlight.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="music.cloud" href="music.cloud.html" /> <link rel="prev" title="music.api" href="music.api.html" /> <link rel="stylesheet" href="../_static/custom.css" type="text/css" /> <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> </head><body> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <section id="music-auth"> <h1>music.auth<a class="headerlink" href="#music-auth" title="Permalink to this heading">¶</a></h1> <section id="module-music.auth"> <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-music.auth" title="Permalink to this heading">¶</a></h2> <p>Security related endpoints including login/logout and reset password</p> </section> <section id="module-music.auth.auth"> <span id="auth-auth"></span><h2>auth.auth<a class="headerlink" href="#module-music.auth.auth" title="Permalink to this heading">¶</a></h2> <dl class="py function"> <dt class="sig sig-object py" id="music.auth.auth.auth"> <span class="sig-prename descclassname"><span class="pre">music.auth.auth.</span></span><span class="sig-name descname"><span class="pre">auth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#music.auth.auth.auth" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="music.auth.auth.deauth"> <span class="sig-prename descclassname"><span class="pre">music.auth.auth.</span></span><span class="sig-name descname"><span class="pre">deauth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#music.auth.auth.deauth" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="music.auth.auth.jwt_token"> <span class="sig-prename descclassname"><span class="pre">music.auth.auth.</span></span><span class="sig-name descname"><span class="pre">jwt_token</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#music.auth.auth.jwt_token" title="Permalink to this definition">¶</a></dt> <dd><p>Generate JWT</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>token request on POST</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p>HTTP Response</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="music.auth.auth.login"> <span class="sig-prename descclassname"><span class="pre">music.auth.auth.</span></span><span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#music.auth.auth.login" title="Permalink to this definition">¶</a></dt> <dd><p>Login route allowing retrieval of HTML page and submission of results</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>Home page redirect for GET, login request on POST</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p>HTTP Response</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="music.auth.auth.logout"> <span class="sig-prename descclassname"><span class="pre">music.auth.auth.</span></span><span class="sig-name descname"><span class="pre">logout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#music.auth.auth.logout" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="music.auth.auth.register"> <span class="sig-prename descclassname"><span class="pre">music.auth.auth.</span></span><span class="sig-name descname"><span class="pre">register</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#music.auth.auth.register" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="music.auth.auth.token"> <span class="sig-prename descclassname"><span class="pre">music.auth.auth.</span></span><span class="sig-name descname"><span class="pre">token</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#music.auth.auth.token" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </section> </section> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h1 class="logo"><a href="../index.html">Mixonomer</a></h1> <h3>Navigation</h3> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="music.html">Py</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="music.api.html">music.api</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">music.auth</a></li> <li class="toctree-l2"><a class="reference internal" href="music.cloud.html">music.cloud</a></li> <li class="toctree-l2"><a class="reference internal" href="music.db.html">music.db</a></li> <li class="toctree-l2"><a class="reference internal" href="music.model.html">music.model</a></li> <li class="toctree-l2"><a class="reference internal" href="music.tasks.html">music.tasks</a></li> <li class="toctree-l2"><a class="reference internal" href="music.html#module-music">music Root Module</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="admin.html">Admin Script</a></li> <li class="toctree-l1 current"><a class="reference internal" href="modules.html">All Modules</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="music.html">Flask Backend</a></li> </ul> </li> </ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="../index.html">Documentation overview</a><ul> <li><a href="music.html">Flask Backend</a><ul> <li>Previous: <a href="music.api.html" title="previous chapter">music.api</a></li> <li>Next: <a href="music.cloud.html" title="next chapter">music.cloud</a></li> </ul></li> </ul></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3 id="searchlabel">Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <input type="submit" value="Go" /> </form> </div> </div> <script>document.getElementById('searchbox').style.display = "block"</script> </div> </div> <div class="clearer"></div> </div> <div class="footer"> ©2021, Sarsoo. | Powered by <a href="http://sphinx-doc.org/">Sphinx 5.3.0</a> & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> | <a href="../_sources/src/music.auth.rst.txt" rel="nofollow">Page source</a> </div> </body> </html>