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

Typo

This commit is contained in:
Zhang Huangbin 2021-04-12 18:24:41 +08:00
parent e33550a783
commit 7f3f9e23a2
2 changed files with 46 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -225,7 +225,20 @@ Notes:
* This is standalone domain admin account, not mail user with admin privileges.
* Only global admin can access these APIs.
!!! api "`GET`{: .get } `/api/admin/<mail>`{: .url } `Get profile of an existing domain admin`{: .comment }"
!!! api "`GET`{: .get } `/api/admin/<mail>`{: .url } `Get profile of an existing domain admin`{: .comment } `Parameters`{: .has_params }"
<div class="params params_user">
Encrypted account password is not exposed in API request by default, if you
want to it for some reason, please add a new line in iRedAdmin-Pro config
file `/opt/www/iredadmin/settings.py` like below, then restart `iredadmin`
service:
```
API_HIDDEN_ADMIN_PROFILES = []
```
</div>
!!! api "`POST`{: .post } `/api/admin/<mail>`{: .url } `Create a new domain admin`{: .comment } `Parameters`{: .has_params }"
<div class="params params_admin">
@ -297,7 +310,20 @@ Notes:
### Mail User {: .toggle }
!!! api "`GET`{: .get } `/api/user/<mail>`{: .url } `Get profile of an existing mail user`{: .comment }"
!!! api "`GET`{: .get } `/api/user/<mail>`{: .url } `Get profile of an existing mail user`{: .comment } `Parameters`{: .has_params }"
<div class="params params_user">
Encrypted account password is not exposed in API request by default, if you
want to it for some reason, please add a new line in iRedAdmin-Pro config
file `/opt/www/iredadmin/settings.py` like below, then restart `iredadmin`
service:
```
API_HIDDEN_USER_PROFILES = []
```
</div>
!!! api "`POST`{: .post } `/api/user/<mail>`{: .url } `Create a new mail user`{: .comment } `Parameters`{: .has_params }"
<div class="params params_user">

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

@ -618,7 +618,15 @@ to be a domain admin.</p>
</ul>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/admin/&lt;mail&gt;</code> <code class="comment">Get profile of an existing domain admin</code></p>
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/admin/&lt;mail&gt;</code> <code class="comment">Get profile of an existing domain admin</code> <code class="has_params">Parameters</code></p>
<p><div class="params params_user">
Encrypted account password is not exposed in API request by default, if you
want to it for some reason, please add a new line in iRedAdmin-Pro config
file <code>/opt/www/iredadmin/settings.py</code> like below, then restart <code>iredadmin</code>
service:</p>
<p><code>API_HIDDEN_ADMIN_PROFILES = []</code></p>
</div>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/admin/&lt;mail&gt;</code> <code class="comment">Create a new domain admin</code> <code class="has_params">Parameters</code></p>
@ -842,7 +850,15 @@ to be a domain admin.</p>
</div>
<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/&lt;mail&gt;</code> <code class="comment">Get profile of an existing mail user</code></p>
<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/user/&lt;mail&gt;</code> <code class="comment">Get profile of an existing mail user</code> <code class="has_params">Parameters</code></p>
<p><div class="params params_user">
Encrypted account password is not exposed in API request by default, if you
want to it for some reason, please add a new line in iRedAdmin-Pro config
file <code>/opt/www/iredadmin/settings.py</code> like below, then restart <code>iredadmin</code>
service:</p>
<p><code>API_HIDDEN_USER_PROFILES = []</code></p>
</div>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/user/&lt;mail&gt;</code> <code class="comment">Create a new mail user</code> <code class="has_params">Parameters</code></p>