Make it clearer about how to enable self-service in iRedAdmin-Pro.
This commit is contained in:
parent
b3bdcec4da
commit
661478212d
|
@ -124,41 +124,24 @@ Notes:
|
||||||
Parameter Name | Summary | Sample Usage
|
Parameter Name | Summary | Sample Usage
|
||||||
--- |--- |---
|
--- |--- |---
|
||||||
`cn` | Display name | `cn=My New Name`
|
`cn` | Display name | `cn=My New Name`
|
||||||
|
`password` | Password | `password=u0tBF82cIV@vi8Gme`
|
||||||
|
`quota` | Mailbox quota (in MB) | `quota=1024`
|
||||||
`accountStatus` | Enable or disable user | `accountStatus=active` (or `disabled`)
|
`accountStatus` | Enable or disable user | `accountStatus=active` (or `disabled`)
|
||||||
`language` | Preferred language of web UI | `language=en_US`
|
`language` | Preferred language of web UI | `language=en_US`
|
||||||
`transport` | Transport program | `transport=dovecot`
|
`transport` | Transport program | `transport=dovecot`
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
!!! api "`PUT`{: .put } `/api/user/<mail>/password`{: .url } `Update user's password`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
|
|
||||||
|
|
||||||
<div class="params">
|
|
||||||
|
|
||||||
Parameter Name | Comment
|
|
||||||
--- |---
|
|
||||||
`password` | Password
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
!!! api "`PUT`{: .put } `/api/users/<domain>`{: .url } `Update profiles of all users under domain`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
|
!!! api "`PUT`{: .put } `/api/users/<domain>`{: .url } `Update profiles of all users under domain`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
|
||||||
|
|
||||||
<div class="params">
|
<div class="params">
|
||||||
|
|
||||||
Parameter Name | Comment
|
Parameter Name | Comment
|
||||||
--- |---
|
--- |---
|
||||||
accountStatus | Account status. Possible value is: active, disabled.
|
`accountStatus` | Account status. Possible value is: active, disabled.
|
||||||
language | Preferred language of web UI
|
|
||||||
transport | Per-user transport
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
!!! api "`PUT`{: .put } `/api/users/<domain>/password`{: .url } `Update passwords of all users under domain`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
|
|
||||||
|
|
||||||
<div class="params">
|
|
||||||
|
|
||||||
Parameter Name | Comment
|
|
||||||
--- |---
|
|
||||||
`password` | Password
|
`password` | Password
|
||||||
|
`language` | Preferred language of web UI
|
||||||
|
`transport` | Per-user transport
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -184,7 +167,22 @@ Notes:
|
||||||
|
|
||||||
### Mail Alias {: .toggle }
|
### Mail Alias {: .toggle }
|
||||||
|
|
||||||
!!! api "`POST`{: .post } `/api/alias/<mail>`{: .url } `Create a new mail alias`{: .comment }"
|
!!! api "`POST`{: .post } `/api/alias/<mail>`{: .url } `Create a new mail alias`{: .comment } `upcoming`{: .upcoming} `Parameters`{: .has_params}"
|
||||||
|
|
||||||
|
<div class="params">
|
||||||
|
|
||||||
|
Parameter Name | Summary | Sample Usage
|
||||||
|
--- |--- |---
|
||||||
|
`cn` | display name | `cn=My List Name`
|
||||||
|
|
||||||
|
<!--
|
||||||
|
`accessPolicy` | Defines who can send email to this mail alias account | `accessPolicy=public`
|
||||||
|
-->
|
||||||
|
|
||||||
|
> Note: `accessPolicy` for mail alias account is only available for SQL backends.
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
!!! api "`DELETE`{: .delete } `/api/alias/<mail>`{: .url } `Delete an existing mail alias`{: .comment }"
|
!!! api "`DELETE`{: .delete } `/api/alias/<mail>`{: .url } `Delete an existing mail alias`{: .comment }"
|
||||||
!!! api "`PUT`{: .put } `/api/alias/<mail>`{: .url } `Update profile of an existing mail alias`{: .comment } `Parameters`{: .has_params }"
|
!!! api "`PUT`{: .put } `/api/alias/<mail>`{: .url } `Update profile of an existing mail alias`{: .comment } `Parameters`{: .has_params }"
|
||||||
|
|
||||||
|
|
|
@ -4,14 +4,15 @@
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
The latest iRedAdmin-Pro release provides self-service, it's a per-domain
|
!!! attention
|
||||||
setting and disabled by default, domain admin can enable it in domain profile
|
|
||||||
page, under tab `Advanced`, and it's able to control which data are allowed to
|
|
||||||
be updated by users themselves.
|
|
||||||
|
|
||||||
With self-service, users are able to manage:
|
Self-service is available in iRedAdmin-Pro versions which were released
|
||||||
|
after Jan 1, 2015.
|
||||||
|
|
||||||
* Update full name, preferred language
|
With self-service, end users are able to manage:
|
||||||
|
|
||||||
|
* Full name
|
||||||
|
* Preferred language of iRedAdmin-Pro web interface
|
||||||
* Change password
|
* Change password
|
||||||
* Mail forwarding control
|
* Mail forwarding control
|
||||||
* Manager per-user whitelists & blacklists
|
* Manager per-user whitelists & blacklists
|
||||||
|
@ -19,6 +20,12 @@ With self-service, users are able to manage:
|
||||||
* Check received mails and blacklist certain senders if they're spammers.
|
* Check received mails and blacklist certain senders if they're spammers.
|
||||||
* Manage basic spam policy
|
* Manage basic spam policy
|
||||||
|
|
||||||
|
## How to enable self-service
|
||||||
|
|
||||||
|
Self-service is a per-domain setting and disabled by default, domain admin can
|
||||||
|
enable it in domain profile page, under tab `Advanced`, and it's able to
|
||||||
|
control which preferences are allowed to be managed by end users themselves.
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
### Update name, preferred language
|
### Update name, preferred language
|
||||||
|
|
|
@ -232,6 +232,16 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
||||||
<td><code>cn=My New Name</code></td>
|
<td><code>cn=My New Name</code></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<td><code>password</code></td>
|
||||||
|
<td>Password</td>
|
||||||
|
<td><code>password=u0tBF82cIV@vi8Gme</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>quota</code></td>
|
||||||
|
<td>Mailbox quota (in MB)</td>
|
||||||
|
<td><code>quota=1024</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
<td><code>accountStatus</code></td>
|
<td><code>accountStatus</code></td>
|
||||||
<td>Enable or disable user</td>
|
<td>Enable or disable user</td>
|
||||||
<td><code>accountStatus=active</code> (or <code>disabled</code>)</td>
|
<td><code>accountStatus=active</code> (or <code>disabled</code>)</td>
|
||||||
|
@ -250,27 +260,6 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="admonition api">
|
|
||||||
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/user/<mail>/password</code> <code class="comment">Update user's password</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
|
|
||||||
<div class="params">
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Parameter Name</th>
|
|
||||||
<th>Comment</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td><code>password</code></td>
|
|
||||||
<td>Password</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<div class="admonition api">
|
<div class="admonition api">
|
||||||
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/users/<domain></code> <code class="comment">Update profiles of all users under domain</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
|
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/users/<domain></code> <code class="comment">Update profiles of all users under domain</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
|
||||||
|
@ -285,42 +274,25 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr>
|
<tr>
|
||||||
<td>accountStatus</td>
|
<td><code>accountStatus</code></td>
|
||||||
<td>Account status. Possible value is: active, disabled.</td>
|
<td>Account status. Possible value is: active, disabled.</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>language</td>
|
<td><code>password</code></td>
|
||||||
|
<td>Password</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>language</code></td>
|
||||||
<td>Preferred language of web UI</td>
|
<td>Preferred language of web UI</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>transport</td>
|
<td><code>transport</code></td>
|
||||||
<td>Per-user transport</td>
|
<td>Per-user transport</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
|
||||||
<div class="admonition api">
|
|
||||||
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/users/<domain>/password</code> <code class="comment">Update passwords of all users under domain</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
|
|
||||||
<div class="params">
|
|
||||||
|
|
||||||
<table>
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Parameter Name</th>
|
|
||||||
<th>Comment</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td><code>password</code></td>
|
|
||||||
<td>Password</td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h3 class="toggle" id="mailing-list">Mailing List</h3>
|
<h3 class="toggle" id="mailing-list">Mailing List</h3>
|
||||||
<div class="admonition attention">
|
<div class="admonition attention">
|
||||||
|
@ -364,7 +336,34 @@ please use mail alias account as mailing list.</p>
|
||||||
</div>
|
</div>
|
||||||
<h3 class="toggle" id="mail-alias">Mail Alias</h3>
|
<h3 class="toggle" id="mail-alias">Mail Alias</h3>
|
||||||
<div class="admonition api">
|
<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></p>
|
<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">
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Parameter Name</th>
|
||||||
|
<th>Summary</th>
|
||||||
|
<th>Sample Usage</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>cn</code></td>
|
||||||
|
<td>display name</td>
|
||||||
|
<td><code>cn=My List Name</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<!--
|
||||||
|
<code>accessPolicy</code> | Defines who can send email to this mail alias account | <code>accessPolicy=public</code>
|
||||||
|
-->
|
||||||
|
|
||||||
|
<blockquote>
|
||||||
|
<p>Note: <code>accessPolicy</code> for mail alias account is only available for SQL backends.</p>
|
||||||
|
</blockquote>
|
||||||
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<div class="admonition api">
|
<div class="admonition api">
|
||||||
<p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/alias/<mail></code> <code class="comment">Delete an existing mail alias</code></p>
|
<p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/alias/<mail></code> <code class="comment">Delete an existing mail alias</code></p>
|
||||||
|
|
|
@ -20,6 +20,7 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#iredadmin-pro-enable-self-service-to-allow-users-to-manage-their-own-preferences-and-more">iRedAdmin-Pro: Enable self-service to allow users to manage their own preferences and more</a><ul>
|
<li><a href="#iredadmin-pro-enable-self-service-to-allow-users-to-manage-their-own-preferences-and-more">iRedAdmin-Pro: Enable self-service to allow users to manage their own preferences and more</a><ul>
|
||||||
<li><a href="#introduction">Introduction</a></li>
|
<li><a href="#introduction">Introduction</a></li>
|
||||||
|
<li><a href="#how-to-enable-self-service">How to enable self-service</a></li>
|
||||||
<li><a href="#screenshots">Screenshots</a><ul>
|
<li><a href="#screenshots">Screenshots</a><ul>
|
||||||
<li><a href="#update-name-preferred-language">Update name, preferred language</a></li>
|
<li><a href="#update-name-preferred-language">Update name, preferred language</a></li>
|
||||||
<li><a href="#change-password">Change password</a></li>
|
<li><a href="#change-password">Change password</a></li>
|
||||||
|
@ -35,13 +36,15 @@
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<h2 id="introduction">Introduction</h2>
|
<h2 id="introduction">Introduction</h2>
|
||||||
<p>The latest iRedAdmin-Pro release provides self-service, it's a per-domain
|
<div class="admonition attention">
|
||||||
setting and disabled by default, domain admin can enable it in domain profile
|
<p class="admonition-title">Attention</p>
|
||||||
page, under tab <code>Advanced</code>, and it's able to control which data are allowed to
|
<p>Self-service is available in iRedAdmin-Pro versions which were released
|
||||||
be updated by users themselves.</p>
|
after Jan 1, 2015.</p>
|
||||||
<p>With self-service, users are able to manage:</p>
|
</div>
|
||||||
|
<p>With self-service, end users are able to manage:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Update full name, preferred language</li>
|
<li>Full name</li>
|
||||||
|
<li>Preferred language of iRedAdmin-Pro web interface</li>
|
||||||
<li>Change password</li>
|
<li>Change password</li>
|
||||||
<li>Mail forwarding control</li>
|
<li>Mail forwarding control</li>
|
||||||
<li>Manager per-user whitelists & blacklists</li>
|
<li>Manager per-user whitelists & blacklists</li>
|
||||||
|
@ -49,6 +52,10 @@ be updated by users themselves.</p>
|
||||||
<li>Check received mails and blacklist certain senders if they're spammers.</li>
|
<li>Check received mails and blacklist certain senders if they're spammers.</li>
|
||||||
<li>Manage basic spam policy</li>
|
<li>Manage basic spam policy</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
<h2 id="how-to-enable-self-service">How to enable self-service</h2>
|
||||||
|
<p>Self-service is a per-domain setting and disabled by default, domain admin can
|
||||||
|
enable it in domain profile page, under tab <code>Advanced</code>, and it's able to
|
||||||
|
control which preferences are allowed to be managed by end users themselves.</p>
|
||||||
<h2 id="screenshots">Screenshots</h2>
|
<h2 id="screenshots">Screenshots</h2>
|
||||||
<h3 id="update-name-preferred-language">Update name, preferred language</h3>
|
<h3 id="update-name-preferred-language">Update name, preferred language</h3>
|
||||||
<p><img alt="" src="../images/iredadmin/self-service.preferences.general.png" /></p>
|
<p><img alt="" src="../images/iredadmin/self-service.preferences.general.png" /></p>
|
||||||
|
|
Loading…
Reference in New Issue