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

Update doc of new iRedAdmin-Pro API: /api/domain/admins/<domain>. used to manage normal domain admins.

This commit is contained in:
Zhang Huangbin 2016-08-02 15:56:26 +08:00
parent ef3d898729
commit 3dc4e29c67
2 changed files with 67 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
en_US/faq/2-iredadmin-pro.restful.api.md
View File

@ -19,8 +19,10 @@
iRedAdmin-Pro RESTful API will return message in JSON format.
* If operation succeed, iRedAdmin-Pro returns JSON data: `{'_success': true}`.
* If operation failed, iRedAdmin-Pro returns JSON data: `{'_success': false, '_msg': '<error_reason>'}`.
* If operation succeed:
* For `POST`, `DELETE`, `PUT` actions, it returns JSON data: `{'_success': true}`.
* For `GET` action, it returns JSON data: `{'_success': true, '_data': <program_output>}`.
* If operation failed, it returns JSON data: `{'_success': false, '_msg': '<error_reason>'}`.
## Requirements
@ -112,15 +114,28 @@ Notes:
</div>
!!! api "`PUT`{: .put } `/api/domain/services/<domain>`{: .url } `Update enabled per-domain services`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
!!! api "`GET`{: .get } `/api/domain/services/<domain>`{: .url } `Get/List all enabled per-domain services`{: .comment } `upcoming`{: .upcoming }"
!!! api "`PUT`{: .put } `/api/domain/services/<domain>`{: .url } `Manage enabled per-domain services`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
<div class="params params_domain_services">
Parameter Name | Summary | Sample Usage
--- |--- |---
`enableService` | Enable new services | `enableService=sogo,vpn,xmpp`
`disableService` | Disable existing services | `disableService=sogo,vpn,xmpp`
`removeAllServices` | Disable all services (including mail service) | `removeAllServices=`
`enableService` | Enable new services. Multiple services must be separated by comma. | `enableService=sogo,vpn,xmpp`
`disableService` | Disable existing services. Multiple services must be separated by comma. | `disableService=sogo,vpn,xmpp`
`removeAllServices` | Disable all services (including mail service) | `removeAllServices=` (empty value)
</div>
!!! api "`PUT`{: .put } `/api/domain/admins/<domain>`{: .url } `Manage normal domain admins.`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
<div class="params params_domain_admins">
Parameter Name | Summary | Sample Usage
--- |--- |---
`addAdmin` | Add new domain admins. Multiple services must be separated by comma. | `addAdmin=one@domain.com,two@domain.com`
`removeAdmin` | Remove existing domain admins. Multiple services must be separated by comma. | `removeAdmin=one@domain.com,two@domain.com`
`removeAllAdmins` | Remove all existing domain admins. | `removeAllAdmins=` (empty value)
</div>

52
html/iredadmin-pro.restful.api.html
View File

@ -58,8 +58,12 @@
<h2 id="summary">Summary</h2>
<p>iRedAdmin-Pro RESTful API will return message in JSON format.</p>
<ul>
<li>If operation succeed, iRedAdmin-Pro returns JSON data: <code>{'_success': true}</code>.</li>
<li>If operation failed, iRedAdmin-Pro returns JSON data: <code>{'_success': false, '_msg': '&lt;error_reason&gt;'}</code>.</li>
<li>If operation succeed:<ul>
<li>For <code>POST</code>, <code>DELETE</code>, <code>PUT</code> actions, it returns JSON data: <code>{'_success': true}</code>.</li>
<li>For <code>GET</code> action, it returns JSON data: <code>{'_success': true, '_data': &lt;program_output&gt;}</code>.</li>
</ul>
</li>
<li>If operation failed, it returns JSON data: <code>{'_success': false, '_msg': '&lt;error_reason&gt;'}</code>.</li>
</ul>
<h2 id="requirements">Requirements</h2>
<ul>
@ -260,7 +264,10 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
</div>
<div class="admonition api">
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/domain/services/&lt;domain&gt;</code> <code class="comment">Update enabled per-domain services</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/domain/services/&lt;domain&gt;</code> <code class="comment">Get/List all enabled per-domain services</code> <code class="upcoming">upcoming</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/domain/services/&lt;domain&gt;</code> <code class="comment">Manage enabled per-domain services</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
<div class="params params_domain_services">
<table>
@ -274,18 +281,51 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
<tbody>
<tr>
<td><code>enableService</code></td>
<td>Enable new services</td>
<td>Enable new services. Multiple services must be separated by comma.</td>
<td><code>enableService=sogo,vpn,xmpp</code></td>
</tr>
<tr>
<td><code>disableService</code></td>
<td>Disable existing services</td>
<td>Disable existing services. Multiple services must be separated by comma.</td>
<td><code>disableService=sogo,vpn,xmpp</code></td>
</tr>
<tr>
<td><code>removeAllServices</code></td>
<td>Disable all services (including mail service)</td>
<td><code>removeAllServices=</code></td>
<td><code>removeAllServices=</code> (empty value)</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/domain/admins/&lt;domain&gt;</code> <code class="comment">Manage normal domain admins.</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
<div class="params params_domain_admins">
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Summary</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>addAdmin</code></td>
<td>Add new domain admins. Multiple services must be separated by comma.</td>
<td><code>addAdmin=one@domain.com,two@domain.com</code></td>
</tr>
<tr>
<td><code>removeAdmin</code></td>
<td>Remove existing domain admins. Multiple services must be separated by comma.</td>
<td><code>removeAdmin=one@domain.com,two@domain.com</code></td>
</tr>
<tr>
<td><code>removeAllAdmins</code></td>
<td>Remove all existing domain admins.</td>
<td><code>removeAllAdmins=</code> (empty value)</td>
</tr>
</tbody>
</table>