summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorFrédéric Buclin <LpSolit@gmail.com>2016-04-27 18:50:13 +0200
committerFrédéric Buclin <LpSolit@gmail.com>2016-04-27 18:50:13 +0200
commit3891b63a1eb52076337885487f251a10580a4a85 (patch)
treedb1463894b756a6bb5114644feeec704ec886eb5 /docs
parentc44470a368465adfe329fcfc32492829a21878da (diff)
downloadbugzilla-3891b63a1eb52076337885487f251a10580a4a85.tar.gz
bugzilla-3891b63a1eb52076337885487f251a10580a4a85.tar.xz
Bug 218917 - Allow the login name to be different from the email address
Original patch by Gervase Markham r=gerv a=dkl
Diffstat (limited to 'docs')
-rw-r--r--docs/en/rst/administering/parameters.rst17
-rw-r--r--docs/en/rst/administering/users.rst14
-rw-r--r--docs/en/rst/api/core/v1/bug.rst7
-rw-r--r--docs/en/rst/api/core/v1/bugzilla.rst2
-rw-r--r--docs/en/rst/api/core/v1/user.rst14
5 files changed, 23 insertions, 31 deletions
diff --git a/docs/en/rst/administering/parameters.rst b/docs/en/rst/administering/parameters.rst
index 0d2d18029..5835d654f 100644
--- a/docs/en/rst/administering/parameters.rst
+++ b/docs/en/rst/administering/parameters.rst
@@ -169,12 +169,6 @@ requirelogin
If this option is set, all access to the system beyond the front page will
require a login. No anonymous users will be permitted.
-webservice_email_filter
- Filter email addresses returned by the WebService API depending on if the
- user is logged in or not. This works similarly to how the web UI currently
- filters email addresses. If requirelogin is enabled, then this parameter
- has no effect as users must be logged in to use Bugzilla anyway.
-
emailregexp
Defines the regular expression used to validate email addresses used for
login names. The default attempts to match fully qualified email addresses
@@ -186,12 +180,6 @@ emailregexpdesc
This description is shown to the user to explain which email addresses are
allowed by the :param:`emailregexp` param.
-emailsuffix
- This is a string to append to any email addresses when actually sending mail
- to that address. It is useful if you have changed the :param:`emailregexp`
- param to only allow local usernames, but you want the mail to be delivered
- to username\@my.local.hostname.
-
createemailregexp
This defines the (case-insensitive) regexp to use for email addresses that
are permitted to self-register. The default (:paramval:`.*`) permits any
@@ -499,9 +487,8 @@ address. The LDAP authentication builds on top of this scheme, rather
than replacing it. The initial log-in is done with a username and
password for the LDAP directory. Bugzilla tries to bind to LDAP using
those credentials and, if successful, tries to map this account to a
-Bugzilla account. If an LDAP mail attribute is defined, the value of this
-attribute is used; otherwise, the :param:`emailsuffix` parameter is appended to
-the LDAP username to form a full email address. If an account for this address
+Bugzilla account. An LDAP mail attribute must be defined.
+If an account for this address
already exists in the Bugzilla installation, it will log in to that account.
If no account for that email address exists, one is created at the time
of login. (In this case, Bugzilla will attempt to use the "displayName"
diff --git a/docs/en/rst/administering/users.rst b/docs/en/rst/administering/users.rst
index e32db2f05..7d5b33399 100644
--- a/docs/en/rst/administering/users.rst
+++ b/docs/en/rst/administering/users.rst
@@ -27,9 +27,7 @@ will appear in the Administration page.
The first screen is a search form to search for existing user
accounts. You can run searches based either on the user ID, real
-name or login name (i.e. the email address, or just the first part
-of the email address if the :param:`emailsuffix` parameter is set).
-The search can be conducted
+name, login name or email address. The search can be conducted
in different ways using the listbox to the right of the text entry
box. You can match by case-insensitive substring (the default),
regular expression, a *reverse* regular expression
@@ -55,13 +53,15 @@ Modifying Users
Once you have found your user, you can change the following
fields:
-- *Login Name*:
- This is generally the user's full email address. However, if you
- have are using the :param:`emailsuffix` parameter, this may
- just be the user's login name. Unless you turn off the
+- *Email Address*:
+ This is the user's full email address. Unless you turn off the
:param:`allowemailchange` parameter, users can change their
login names themselves (to any valid email address).
+- *Login Name*:
+ This is the user's login name, if it is (or can be) different from their email
+ address (i.e. if the "use_email_as_login" parameter is switched off).
+
- *Real Name*: The user's real name. Note that
Bugzilla does not require this to create an account.
diff --git a/docs/en/rst/api/core/v1/bug.rst b/docs/en/rst/api/core/v1/bug.rst
index e13b17129..8b253a32c 100644
--- a/docs/en/rst/api/core/v1/bug.rst
+++ b/docs/en/rst/api/core/v1/bug.rst
@@ -251,8 +251,6 @@ name type description
id int The user ID for this user.
real_name string The 'real' name for this user, if any.
name string The user's Bugzilla login.
-email string The user's email address. Currently this is the same value as
- the name.
========= ====== ==============================================================
Flag object:
@@ -291,6 +289,11 @@ field name in ``include_fields``.
* 102 (Access Denied)
You do not have access to the bug_id you specified.
+**History**
+
+Since Bugzilla 6.0, the email address of users is private and is no longer
+returned as part of the user object.
+
.. _rest_history:
Bug History
diff --git a/docs/en/rst/api/core/v1/bugzilla.rst b/docs/en/rst/api/core/v1/bugzilla.rst
index 5aca556ec..f0ba58e65 100644
--- a/docs/en/rst/api/core/v1/bugzilla.rst
+++ b/docs/en/rst/api/core/v1/bugzilla.rst
@@ -178,7 +178,6 @@ Example response for authenticated user:
"defaultseverity" : "normal",
"duplicate_or_move_bug_status" : "RESOLVED",
"emailregexp" : "^[\\w\\.\\+\\-=']+@[\\w\\.\\-]+\\.[\\w\\-]+$",
- "emailsuffix" : "",
"letsubmitterchoosemilestone" : "1",
"letsubmitterchoosepriority" : "1",
"mailfrom" : "bugzilla-daemon@example.com",
@@ -214,7 +213,6 @@ A logged-in user can access the following parameters (listed alphabetically):
* defaultseverity
* duplicate_or_move_bug_status
* emailregexpdesc
-* emailsuffix
* letsubmitterchoosemilestone
* letsubmitterchoosepriority
* mailfrom
diff --git a/docs/en/rst/api/core/v1/user.rst b/docs/en/rst/api/core/v1/user.rst
index 0638ef758..90728287e 100644
--- a/docs/en/rst/api/core/v1/user.rst
+++ b/docs/en/rst/api/core/v1/user.rst
@@ -142,6 +142,8 @@ to perform this action.
========== ====== =============================================================
name type description
========== ====== =============================================================
+**login** string The login name for the new user. Ignored if the
+ *use_email_as_login* parameter is true.
**email** string The email address for the new user.
full_name string The user's full name. Will be set to empty if not specified.
password string The password for the new user account, in plain text. It
@@ -173,6 +175,10 @@ id int The numeric ID of the user that was created.
The password specified is too short. (Usually, this means the
password is under three characters.)
+**History**
+
+The *login* parameter has been added in Bugzilla 6.0.
+
.. _rest_user_update:
Update User
@@ -203,8 +209,7 @@ login names using the ``ids`` or ``names`` parameters respectively.
**ids** array Additional IDs of users to update.
**names** array Additional login names of users to update.
full_name string The new name of the user.
-email string The email of the user. Note that email used to
- login to bugzilla. Also note that you can only
+email string The email of the user. Also note that you can only
update one user at a time when changing the login
name / email. (An error will be thrown if you try to
update this field for multiple users at once.)
@@ -357,8 +362,7 @@ id int The unique integer ID that Bugzilla uses to represen
this will not change.
real_name string The actual name of the user. May be blank.
email string The email address of the user.
-name string The login name of the user. Note that in some
- situations this is different than their email.
+name string The login name of the user.
can_login boolean A boolean value to indicate if the user can login
into bugzilla.
email_enabled boolean A boolean value to indicate if bug-related mail will
@@ -404,7 +408,7 @@ query string The CGI parameters for the saved report.
If you are not authenticated when you call this function, you will only be
returned the ``id``, ``name``, and ``real_name`` items. If you are authenticated
and not in 'editusers' group, you will only be returned the ``id``, ``name``,
-``real_name``, ``email``, ``can_login``, and ``groups`` items. The groups
+``real_name``, ``can_login``, and ``groups`` items. The groups
returned are filtered based on your permission to bless each group. The
``saved_searches`` and ``saved_reports`` items are only returned if you are
querying your own account, even if you are in the editusers group.