diff --git a/en_US/faq/2-iredadmin-pro.restful.api.md b/en_US/faq/2-iredadmin-pro.restful.api.md index a2aad7c1..be1a939e 100644 --- a/en_US/faq/2-iredadmin-pro.restful.api.md +++ b/en_US/faq/2-iredadmin-pro.restful.api.md @@ -124,41 +124,24 @@ Notes: Parameter Name | Summary | Sample Usage --- |--- |--- `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`) `language` | Preferred language of web UI | `language=en_US` `transport` | Transport program | `transport=dovecot` -!!! api "`PUT`{: .put } `/api/user//password`{: .url } `Update user's password`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }" - -
- - Parameter Name | Comment - --- |--- - `password` | Password - -
- !!! api "`PUT`{: .put } `/api/users/`{: .url } `Update profiles of all users under domain`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
Parameter Name | Comment --- |--- - accountStatus | Account status. Possible value is: active, disabled. - language | Preferred language of web UI - transport | Per-user transport - -
- -!!! api "`PUT`{: .put } `/api/users//password`{: .url } `Update passwords of all users under domain`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }" - -
- - Parameter Name | Comment - --- |--- + `accountStatus` | Account status. Possible value is: active, disabled. `password` | Password + `language` | Preferred language of web UI + `transport` | Per-user transport
@@ -184,7 +167,22 @@ Notes: ### Mail Alias {: .toggle } -!!! api "`POST`{: .post } `/api/alias/`{: .url } `Create a new mail alias`{: .comment }" +!!! api "`POST`{: .post } `/api/alias/`{: .url } `Create a new mail alias`{: .comment } `upcoming`{: .upcoming} `Parameters`{: .has_params}" + +
+ + Parameter Name | Summary | Sample Usage + --- |--- |--- + `cn` | display name | `cn=My List Name` + + + + > Note: `accessPolicy` for mail alias account is only available for SQL backends. + +
+ !!! api "`DELETE`{: .delete } `/api/alias/`{: .url } `Delete an existing mail alias`{: .comment }" !!! api "`PUT`{: .put } `/api/alias/`{: .url } `Update profile of an existing mail alias`{: .comment } `Parameters`{: .has_params }" diff --git a/en_US/faq/2-iredadmin-pro.self-service.md b/en_US/faq/2-iredadmin-pro.self-service.md index 99f6d1f5..fc2d9713 100644 --- a/en_US/faq/2-iredadmin-pro.self-service.md +++ b/en_US/faq/2-iredadmin-pro.self-service.md @@ -4,14 +4,15 @@ ## Introduction -The latest iRedAdmin-Pro release provides self-service, it's 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 data are allowed to -be updated by users themselves. +!!! attention -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 * Mail forwarding control * 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. * 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 ### Update name, preferred language diff --git a/html/iredadmin-pro.restful.api.html b/html/iredadmin-pro.restful.api.html index 01662252..03bd5950 100644 --- a/html/iredadmin-pro.restful.api.html +++ b/html/iredadmin-pro.restful.api.html @@ -232,6 +232,16 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...] 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) @@ -250,27 +260,6 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...] - -
-

PUT /api/user/<mail>/password Update user's password upcoming Parameters

-
- - - - - - - - - - - - - - -
Parameter NameComment
passwordPassword
-
-

PUT /api/users/<domain> Update profiles of all users under domain upcoming Parameters

@@ -285,42 +274,25 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...] -accountStatus +accountStatus Account status. Possible value is: active, disabled. -language +password +Password + + +language Preferred language of web UI -transport +transport Per-user transport
- -
-

PUT /api/users/<domain>/password Update passwords of all users under domain upcoming Parameters

-
- - - - - - - - - - - - - - -
Parameter NameComment
passwordPassword
-
-

Mailing List

@@ -364,7 +336,34 @@ please use mail alias account as mailing list.

Mail Alias

-

POST /api/alias/<mail> Create a new mail alias

+

POST /api/alias/<mail> Create a new mail alias upcoming Parameters

+
+ + + + + + + + + + + + + + + + +
Parameter NameSummarySample Usage
cndisplay namecn=My List Name
+ + +
+

Note: accessPolicy for mail alias account is only available for SQL backends.

+
+
+

DELETE /api/alias/<mail> Delete an existing mail alias

diff --git a/html/iredadmin-pro.self-service.html b/html/iredadmin-pro.self-service.html index 113b7dd5..a5c74481 100644 --- a/html/iredadmin-pro.self-service.html +++ b/html/iredadmin-pro.self-service.html @@ -20,6 +20,7 @@

Introduction

-

The latest iRedAdmin-Pro release provides self-service, it's 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 data are allowed to -be updated by users themselves.

-

With self-service, users are able to manage:

+
+

Attention

+

Self-service is available in iRedAdmin-Pro versions which were released +after Jan 1, 2015.

+
+

With self-service, end users are able to manage:

    -
  • Update full name, preferred language
    • +
  • Full name
    • +
  • Preferred language of iRedAdmin-Pro web interface
  • Change password
  • Mail forwarding control
  • Manager per-user whitelists & blacklists
    • @@ -49,6 +52,10 @@ be updated by users themselves.

  • Check received mails and blacklist certain senders if they're spammers.
  • 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

Update name, preferred language