2021-03-23 22:46:23 +00:00
<!DOCTYPE html>
2022-08-26 19:34:19 +01:00
< html lang = "en" >
2021-03-23 22:46:23 +00:00
< head >
< meta charset = "utf-8" / >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
2022-08-26 19:34:19 +01:00
< script src = "../_static/_sphinx_javascript_frameworks_compat.js" > < / script >
2021-03-23 22:46:23 +00:00
< script src = "../_static/doctools.js" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2021-03-24 10:15:52 +00:00
< link rel = "next" title = "music.cloud" href = "music.cloud.html" / >
< link rel = "prev" title = "music.api" href = "music.api.html" / >
2021-03-23 22:46:23 +00:00
< 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" >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-24 10:15:52 +00:00
< p > Security related endpoints including login/logout and reset password< / p >
2022-08-26 19:34:19 +01:00
< / 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 >
2021-03-23 22:46:23 +00:00
< dl class = "py function" >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< dd > < / dd > < / dl >
< dl class = "py function" >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< dd > < / dd > < / dl >
< dl class = "py function" >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< dd > < p > Login route allowing retrieval of HTML page and submission of results< / p >
< dl class = "field-list simple" >
2022-08-26 19:34:19 +01:00
< dt class = "field-odd" > Returns< span class = "colon" > :< / span > < / dt >
2021-03-23 22:46:23 +00:00
< dd class = "field-odd" > < p > Home page redirect for GET, login request on POST< / p >
< / dd >
2022-08-26 19:34:19 +01:00
< dt class = "field-even" > Return type< span class = "colon" > :< / span > < / dt >
2021-03-23 22:46:23 +00:00
< dd class = "field-even" > < p > HTTP Response< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py function" >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< dd > < / dd > < / dl >
< dl class = "py function" >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< dd > < / dd > < / dl >
< dl class = "py function" >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< dd > < / dd > < / dl >
2022-08-26 19:34:19 +01:00
< / section >
< / section >
2021-03-23 22:46:23 +00:00
< / div >
< / div >
< / div >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
2022-08-26 19:34:19 +01:00
< h1 class = "logo" > < a href = "../index.html" > Mixonomer< / a > < / h1 >
2021-03-23 22:46:23 +00:00
< h3 > Navigation< / h3 >
2022-08-26 19:34:19 +01:00
< p class = "caption" role = "heading" > < span class = "caption-text" > Contents:< / span > < / p >
2021-03-23 22:46:23 +00:00
< ul class = "current" >
2021-06-12 14:00:38 +01:00
< 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 >
2021-06-19 13:01:25 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "admin.html" > Admin Script< / a > < / li >
2022-08-26 19:34:19 +01:00
< 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 >
2021-03-23 22:46:23 +00:00
< / ul >
< div class = "relations" >
< h3 > Related Topics< / h3 >
< ul >
< li > < a href = "../index.html" > Documentation overview< / a > < ul >
2021-06-12 14:00:38 +01:00
< li > < a href = "music.html" > Flask Backend< / a > < ul >
2021-03-24 10:15:52 +00:00
< 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 >
2021-03-23 22:46:23 +00:00
< / 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" >
2022-08-26 19:34:19 +01:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
2021-03-23 22:46:23 +00:00
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
2022-08-26 19:34:19 +01:00
< script > document . getElementById ( 'searchbox' ) . style . display = "block" < / script >
2021-03-23 22:46:23 +00:00
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "footer" >
© 2021, Sarsoo.
|
2022-08-26 19:34:19 +01:00
Powered by < a href = "http://sphinx-doc.org/" > Sphinx 5.1.1< / a >
2021-03-23 22:46:23 +00:00
& < 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 >
