New iRedAdmin-Pro API: /api/verify_password/user/<mail>. Verify given (plain) password against the one stored in SQL database.
This commit is contained in:
parent
1cff0054e2
commit
281394e6a9
|
@ -69,9 +69,7 @@ Notes:
|
|||
|
||||
### Domain {: .toggle }
|
||||
|
||||
<!--
|
||||
!!! api "`GET`{: .get } `/api/domain/<domain>`{: .url } `Get profile of an existing domain`{: .comment }"
|
||||
-->
|
||||
!!! api "`GET`{: .get } `/api/domain/<domain>`{: .url } `Get profile of an existing domain`{: .comment } `upcoming`{: .upcoming }"
|
||||
!!! api "`POST`{: .post } `/api/domain/<domain>`{: .url } `Create a new domain`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params params_domain">
|
||||
|
@ -145,8 +143,9 @@ Notes:
|
|||
|
||||
</div>
|
||||
|
||||
### User {: .toggle }
|
||||
### Mail User {: .toggle }
|
||||
|
||||
!!! api "`GET`{: .get } `/api/user/<mail>`{: .url } `Get profile of an existing mail user`{: .comment } `upcoming`{: .upcoming }"
|
||||
!!! api "`POST`{: .post } `/api/user/<mail>`{: .url } `Create a new mail user`{: .comment } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params params_user">
|
||||
|
@ -189,6 +188,16 @@ Notes:
|
|||
|
||||
</div>
|
||||
|
||||
!!! api "`POST`{: .post } `/api/verify_password/user/<mail>`{: .url } `Verify given (plain) password against the one stored in SQL/LDAP`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params} "
|
||||
|
||||
<div class="params params_user">
|
||||
|
||||
Parameter Name | Summary | Sample Usage
|
||||
--- |--- |---
|
||||
`password` | Plain password | `password=u0tBF82cIV@vi8Gme`
|
||||
|
||||
</div>
|
||||
|
||||
### Mailing List {: .toggle }
|
||||
|
||||
!!! attention
|
||||
|
@ -211,6 +220,7 @@ Notes:
|
|||
|
||||
### Mail Alias {: .toggle }
|
||||
|
||||
!!! api "`GET`{: .get } `/api/alias/<mail>`{: .url } `Get profile of an existing mail alias`{: .comment } `upcoming`{: .upcoming }"
|
||||
!!! api "`POST`{: .post } `/api/alias/<mail>`{: .url } `Create a new mail alias`{: .comment } `upcoming`{: .upcoming} `Parameters`{: .has_params}"
|
||||
|
||||
<div class="params">
|
||||
|
|
|
@ -260,8 +260,7 @@ h2, h3, h4, h5 { padding-top: 20px; }
|
|||
pre, code {
|
||||
background: #f5f5f5;
|
||||
border: 1px solid #ccc;
|
||||
/*border-radius: 3px;*/
|
||||
overflow-x: auto;
|
||||
border-radius: 2px;
|
||||
padding: 5px 10px 5px 10px;
|
||||
word-wrap: normal;
|
||||
font-size: 14px;
|
||||
|
@ -420,7 +419,6 @@ button, .button { font-size: 16px; padding: 5px 5px 5px 5px; }
|
|||
float: right;
|
||||
width: auto;
|
||||
cursor: pointer;
|
||||
-webkit-appearance: button;
|
||||
}
|
||||
.api code.comment {
|
||||
color: black;
|
||||
|
|
|
@ -31,7 +31,7 @@
|
|||
<li><a href="#sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</a></li>
|
||||
<li><a href="#apis">APIs</a><ul>
|
||||
<li><a href="#domain">Domain</a></li>
|
||||
<li><a href="#user">User</a></li>
|
||||
<li><a href="#mail-user">Mail User</a></li>
|
||||
<li><a href="#mailing-list">Mailing List</a></li>
|
||||
<li><a href="#mail-alias">Mail Alias</a></li>
|
||||
<li><a href="#throttling">Throttling</a></li>
|
||||
|
@ -101,10 +101,9 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
|||
</ul>
|
||||
<p><button type="button" class="toggle_all">Expand/Collapse All API Parameters</button></p>
|
||||
<h3 class="toggle" id="domain">Domain</h3>
|
||||
<!--
|
||||
!!! api "`GET`{: .get } `/api/domain/<domain>`{: .url } `Get profile of an existing domain`{: .comment }"
|
||||
-->
|
||||
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/domain/<domain></code> <code class="comment">Get profile of an existing domain</code> <code class="upcoming">upcoming</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/domain/<domain></code> <code class="comment">Create a new domain</code> <code class="has_params">Parameters</code></p>
|
||||
<div class="params params_domain">
|
||||
|
@ -338,7 +337,10 @@ to be a domain admin.</p>
|
|||
</div>
|
||||
|
||||
</div>
|
||||
<h3 class="toggle" id="user">User</h3>
|
||||
<h3 class="toggle" id="mail-user">Mail User</h3>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/user/<mail></code> <code class="comment">Get profile of an existing mail user</code> <code class="upcoming">upcoming</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/user/<mail></code> <code class="comment">Create a new mail user</code> <code class="has_params">Parameters</code></p>
|
||||
<div class="params params_user">
|
||||
|
@ -460,6 +462,29 @@ to be a domain admin.</p>
|
|||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/verify_password/user/<mail></code> <code class="comment">Verify given (plain) password against the one stored in SQL/LDAP</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code> </p>
|
||||
<div class="params params_user">
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Parameter Name</th>
|
||||
<th>Summary</th>
|
||||
<th>Sample Usage</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>password</code></td>
|
||||
<td>Plain password</td>
|
||||
<td><code>password=u0tBF82cIV@vi8Gme</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<h3 class="toggle" id="mailing-list">Mailing List</h3>
|
||||
<div class="admonition attention">
|
||||
|
@ -503,6 +528,9 @@ please use mail alias account as mailing list.</p>
|
|||
</div>
|
||||
<h3 class="toggle" id="mail-alias">Mail Alias</h3>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/alias/<mail></code> <code class="comment">Get profile of an existing mail alias</code> <code class="upcoming">upcoming</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/alias/<mail></code> <code class="comment">Create a new mail alias</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
|
||||
<div class="params">
|
||||
|
||||
|
|
Loading…
Reference in New Issue