mirror of
https://github.com/pds-nest/nest.git
synced 2024-11-29 07:54:19 +00:00
160 lines
No EOL
7.1 KiB
HTML
160 lines
No EOL
7.1 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>nest_backend.routes.users package — N.E.S.T. Backend documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/alabaster.css" type="text/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>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="prev" title="nest_backend.routes.repository package" href="nest_backend.routes.repository.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">
|
||
|
||
<div class="section" id="nest-backend-routes-users-package">
|
||
<h1>nest_backend.routes.users package<a class="headerlink" href="#nest-backend-routes-users-package" 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>
|
||
<div class="section" id="module-nest_backend.routes.users.login">
|
||
<span id="nest-backend-routes-users-login-module"></span><h2>nest_backend.routes.users.login module<a class="headerlink" href="#module-nest_backend.routes.users.login" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="py function">
|
||
<dt id="nest_backend.routes.users.login.page_login">
|
||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.users.login.</span></code><code class="sig-name descname"><span class="pre">page_login</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.users.login.page_login" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The API call that allows to log-in. It requires:
|
||
:parameter email: The user’s email
|
||
:parameter password: The users’s password
|
||
:returns: Json-formatted data. If the login is successful, it will contain the access_token and the users data.</p>
|
||
<p>The access_token must be included in the Authorization header, using the format Bearer <token>.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-nest_backend.routes.users.user_create">
|
||
<span id="nest-backend-routes-users-user-create-module"></span><h2>nest_backend.routes.users.user_create module<a class="headerlink" href="#module-nest_backend.routes.users.user_create" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="py function">
|
||
<dt id="nest_backend.routes.users.user_create.page_user_create">
|
||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.users.user_create.</span></code><code class="sig-name descname"><span class="pre">page_user_create</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.users.user_create.page_user_create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The API call that allows to create new users. It requires:
|
||
:parameter email: The user’s email
|
||
:parameter password: The users’s password
|
||
:parameter username: The users’s username
|
||
:return: Json-formatted data. If something goes wrong, it returns a
|
||
{‘result’:’failure’, ‘content’:’something blew up’}, else it returns {‘result’:’success’, ‘content’:newUser.to_json().</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-nest_backend.routes.users.user_delete">
|
||
<span id="nest-backend-routes-users-user-delete-module"></span><h2>nest_backend.routes.users.user_delete module<a class="headerlink" href="#module-nest_backend.routes.users.user_delete" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="py function">
|
||
<dt id="nest_backend.routes.users.user_delete.page_user_delete">
|
||
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.users.user_delete.</span></code><code class="sig-name descname"><span class="pre">page_user_delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.users.user_delete.page_user_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>API call that allows an user to be deleted from NEST.
|
||
:parameter email: The email of the user that needs to be removed.
|
||
:return: JSON-formatted data. If the user has the privilege, the target user exists and differs from the current
|
||
user, the target gets deleted and a json containing the field “result”:”success” is returned.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-nest_backend.routes.users">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend.routes.users" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="nest_backend.html">nest_backend package</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="modules.html">backend</a><ul>
|
||
<li><a href="nest_backend.html">nest_backend package</a><ul>
|
||
<li><a href="nest_backend.routes.html">nest_backend.routes package</a><ul>
|
||
<li>Previous: <a href="nest_backend.routes.repository.html" title="previous chapter">nest_backend.routes.repository package</a></li>
|
||
</ul></li>
|
||
</ul></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" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2021, Gruppo 2.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||
|
||
|
|
||
<a href="_sources/nest_backend.routes.users.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |