Files
PINE/docs/build/html/autoapi/pine/backend/auth/index.html
Laura Glendenning d9cdcf1721 Updates from internal development branch.
This includes two main features:

1. Add/fix status/train/predict endpoints for pipelines.
2. Add OpenAPI specification for backend API.
2021-08-04 11:38:21 -04:00

203 lines
12 KiB
HTML

<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pine.backend.auth &#8212; pine documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/bizstyle.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" />
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/bizstyle.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<link rel="next" title="pine.backend.auth.bp" href="bp/index.html" />
<link rel="prev" title="pine.backend.api.bp" href="../api/bp/index.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
<!--[if lt IE 9]>
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="bp/index.html" title="pine.backend.auth.bp"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../api/bp/index.html" title="pine.backend.api.bp"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">pine documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >API Reference</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../index.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine</span></code></a> &#187;</li>
<li class="nav-item nav-item-3"><a href="../index.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend</span></code></a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth</span></code></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pine.backend.auth">
<span id="pine-backend-auth"></span><h1><a class="reference internal" href="#module-pine.backend.auth" title="pine.backend.auth"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth</span></code></a><a class="headerlink" href="#module-pine.backend.auth" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="bp/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.bp</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="eve/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.eve</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="oauth/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.oauth</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="password/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.password</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="vegas/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.vegas</span></code></a></li>
</ul>
</div>
</div>
<div class="section" id="package-contents">
<h2>Package Contents<a class="headerlink" href="#package-contents" title="Permalink to this headline"></a></h2>
<div class="section" id="functions">
<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#pine.backend.auth.login_required" title="pine.backend.auth.login_required"><code class="xref py py-obj docutils literal notranslate"><span class="pre">login_required</span></code></a>(view)</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pine.backend.auth.admin_required" title="pine.backend.auth.admin_required"><code class="xref py py-obj docutils literal notranslate"><span class="pre">admin_required</span></code></a>(view)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pine.backend.auth.get_logged_in_user" title="pine.backend.auth.get_logged_in_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_logged_in_user</span></code></a>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pine.backend.auth.is_flat" title="pine.backend.auth.is_flat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_flat</span></code></a>()</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<dl class="py function">
<dt id="pine.backend.auth.login_required">
<code class="sig-prename descclassname"><span class="pre">pine.backend.auth.</span></code><code class="sig-name descname"><span class="pre">login_required</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pine.backend.auth.login_required" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="pine.backend.auth.admin_required">
<code class="sig-prename descclassname"><span class="pre">pine.backend.auth.</span></code><code class="sig-name descname"><span class="pre">admin_required</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pine.backend.auth.admin_required" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt id="pine.backend.auth.module">
<code class="sig-prename descclassname"><span class="pre">pine.backend.auth.</span></code><code class="sig-name descname"><span class="pre">module</span></code><a class="headerlink" href="#pine.backend.auth.module" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="pine.backend.auth.get_logged_in_user">
<code class="sig-prename descclassname"><span class="pre">pine.backend.auth.</span></code><code class="sig-name descname"><span class="pre">get_logged_in_user</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pine.backend.auth.get_logged_in_user" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="pine.backend.auth.is_flat">
<code class="sig-prename descclassname"><span class="pre">pine.backend.auth.</span></code><code class="sig-name descname"><span class="pre">is_flat</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pine.backend.auth.is_flat" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth</span></code></a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#package-contents">Package Contents</a><ul>
<li><a class="reference internal" href="#functions">Functions</a><ul>
<li><a class="reference internal" href="#pine.backend.auth.login_required">login_required</a></li>
<li><a class="reference internal" href="#pine.backend.auth.admin_required">admin_required</a></li>
<li><a class="reference internal" href="#pine.backend.auth.module">module</a></li>
<li><a class="reference internal" href="#pine.backend.auth.get_logged_in_user">get_logged_in_user</a></li>
<li><a class="reference internal" href="#pine.backend.auth.is_flat">is_flat</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../api/bp/index.html"
title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.api.bp</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="bp/index.html"
title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth.bp</span></code></a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../../_sources/autoapi/pine/backend/auth/index.rst.txt"
rel="nofollow">Show Source</a></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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="bp/index.html" title="pine.backend.auth.bp"
>next</a> |</li>
<li class="right" >
<a href="../api/bp/index.html" title="pine.backend.api.bp"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">pine documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >API Reference</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../index.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine</span></code></a> &#187;</li>
<li class="nav-item nav-item-3"><a href="../index.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend</span></code></a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">pine.backend.auth</span></code></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright (C) 2019 The Johns Hopkins University Applied Physics Laboratory LLC..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.3.
</div>
</body>
</html>