summaryrefslogtreecommitdiffstats
path: root/Bugzilla/WebService/User.pm
diff options
context:
space:
mode:
Diffstat (limited to 'Bugzilla/WebService/User.pm')
-rwxr-xr-xBugzilla/WebService/User.pm39
1 files changed, 31 insertions, 8 deletions
diff --git a/Bugzilla/WebService/User.pm b/Bugzilla/WebService/User.pm
index 10537138c..24b9be709 100755
--- a/Bugzilla/WebService/User.pm
+++ b/Bugzilla/WebService/User.pm
@@ -238,14 +238,16 @@ log in/out using an existing account.
=head1 METHODS
-See L<Bugzilla::WebService> for a description of what B<STABLE>, B<UNSTABLE>,
-and B<EXPERIMENTAL> mean, and for more information about error codes.
+See L<Bugzilla::WebService> for a description of how parameters are passed,
+and what B<STABLE>, B<UNSTABLE>, and B<EXPERIMENTAL> mean.
=head2 Logging In and Out
=over
-=item C<login> B<EXPERIMENTAL>
+=item C<login>
+
+B<STABLE>
=over
@@ -301,7 +303,9 @@ A login or password parameter was not provided.
=back
-=item C<logout> B<EXPERIMENTAL>
+=item C<logout>
+
+B<STABLE>
=over
@@ -323,7 +327,9 @@ Log out the user. Does nothing if there is no user logged in.
=over
-=item C<offer_account_by_email> B<EXPERIMENTAL>
+=item C<offer_account_by_email>
+
+B<STABLE>
=over
@@ -362,7 +368,9 @@ An account with that email address already exists in Bugzilla.
=back
-=item C<create> B<EXPERIMENTAL>
+=item C<create>
+
+B<EXPERIMENTAL>
=over
@@ -373,6 +381,9 @@ Instead of this, you should use L</offer_account_by_email> when
possible, because that makes sure that the email address specified can
actually receive an email. This function does not check that.
+You must be logged in and have the C<editusers> privilege in order to
+call this function.
+
=item B<Params>
=over
@@ -423,7 +434,9 @@ password is over ten characters.)
=over
-=item C<get> B<UNSTABLE>
+=item C<get>
+
+B<UNSTABLE>
=over
@@ -465,7 +478,9 @@ each string, which defaults to 1000 but can be changed by the Bugzilla
administrator.
Logged-out users cannot use this argument, and an error will be thrown
-if they try.
+if they try. (This is to make it harder for spammers to harvest email
+addresses from Bugzilla, and also to enforce the user visibility
+restrictions that are implemented on some Bugzillas.)
=item C<include_fields> (array)
@@ -564,6 +579,14 @@ function.
=back
+=item B<History>
+
+=over
+
+=item Added in Bugzilla B<3.4>.
+
+=back
+
=back
=back