elmau
/
iredmail-doc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Sync doc of iRedAdmin-Pro RESTful API.

This commit is contained in:
Zhang Huangbin 2019-03-07 17:24:00 +08:00
parent f306b1b1f8
commit 7202cb0bdb
2 changed files with 44 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
en_US/iredadmin/0-iredadmin-pro.restful.api.new.md
View File

@ -382,7 +382,18 @@ Notes:
</div>
!!! api "`POST`{: .post } `/api/user/<mail>/change_email/<new_mail>`{: .url } `Change user's email address (from '<mail>' to '<new_mail>')`{: .comment }"
!!! api "`PUT`{: .put } `/api/users/<domain>`{: .url } `Update profiles of all users under domain`{: .comment } `Parameters`{: .has_params }"
!!! api "`GET`{: .get } `/api/users/<domain>`{: .url } `Get user profiles under given domain`{: .comment } `Parameters`{: .has_params }"
<div class="params">
Parameter | Default Value | Comment | Sample Usage
--- |--- |--- |---
`email_only` | `no` | Return a list of mail users' email addresses instead of detailed profiles. | `email_only=yes`
`disabled_only` | `no` | Return only disabled mail domains | `disabled_only=yes`
</div>
!!! api "`PUT`{: .put } `/api/users/<domain>`{: .url } `Update profiles of all users under given domain`{: .comment } `Parameters`{: .has_params }"
<div class="params">

33
html/iredadmin-pro.restful.api.new.html
View File

@ -1075,7 +1075,38 @@ to be a domain admin.</p>
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/user/&lt;mail&gt;/change_email/&lt;new_mail&gt;</code> <code class="comment">Change user's email address (from '&lt;mail&gt;' to '&lt;new_mail&gt;')</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/users/&lt;domain&gt;</code> <code class="comment">Update profiles of all users under domain</code> <code class="has_params">Parameters</code></p>
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/users/&lt;domain&gt;</code> <code class="comment">Get user profiles under given domain</code> <code class="has_params">Parameters</code></p>
<div class="params">
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Default Value</th>
<th>Comment</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>email_only</code></td>
<td><code>no</code></td>
<td>Return a list of mail users' email addresses instead of detailed profiles.</td>
<td><code>email_only=yes</code></td>
</tr>
<tr>
<td><code>disabled_only</code></td>
<td><code>no</code></td>
<td>Return only disabled mail domains</td>
<td><code>disabled_only=yes</code></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/users/&lt;domain&gt;</code> <code class="comment">Update profiles of all users under given domain</code> <code class="has_params">Parameters</code></p>
<div class="params">
<table>