<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>
Bugzilla::Webservice::User</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="style" type="text/css" href="../.././../../../../style.css" media="all" >
</head>
<body id="pod">
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<h1>Bugzilla::Webservice::User</h1>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
<li class='indexItem indexItem1'><a href='#Logging_In_and_Out'>Logging In and Out</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#login'>login</a>
<li class='indexItem indexItem2'><a href='#logout'>logout</a>
<li class='indexItem indexItem2'><a href='#valid_login'>valid_login</a>
</ul>
<li class='indexItem indexItem1'><a href='#Account_Creation_and_Modification'>Account Creation and Modification</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#offer_account_by_email'>offer_account_by_email</a>
<li class='indexItem indexItem2'><a href='#create'>create</a>
<li class='indexItem indexItem2'><a href='#update'>update</a>
</ul>
<li class='indexItem indexItem1'><a href='#User_Info'>User Info</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#get'>get</a>
</ul>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Bugzilla::Webservice::User - The User Account and Login API</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>This part of the Bugzilla API allows you to create User Accounts and log in/out using an existing account.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>
<p>See <a href="../../Bugzilla/WebService.html" class="podlinkpod"
>Bugzilla::WebService</a> for a description of how parameters are passed,
and what <b>STABLE</b>,
<b>UNSTABLE</b>,
and <b>EXPERIMENTAL</b> mean.</p>
<p>Although the data input and output is the same for JSONRPC,
XMLRPC and REST,
the directions for how to access the data via REST is noted in each method where applicable.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="Logging_In_and_Out"
>Logging In and Out</a></h1>
<p>These method are now deprecated,
and will be removed in the release after Bugzilla 5.0.
The correct way of use these REST and RPC calls is noted in <a href="../../Bugzilla/WebService.html" class="podlinkpod"
>Bugzilla::WebService</a></p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="login"
>login</a></h2>
<p><b>DEPRECATED</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Logging in,
with a username and password,
is required for many Bugzilla installations,
in order to search for bugs,
post new bugs,
etc.
This method logs in an user.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<dl>
<dt><a name="login_(string)_-_The_user's_login_name."
><code class="code">login</code> (string) - The user's login name.</a></dt>
<dd>
<dt><a name="password_(string)_-_The_user's_password."
><code class="code">password</code> (string) - The user's password.</a></dt>
<dd>
<dt><a
><code class="code">restrict_login</code> (bool) <b>Optional</b> - If set to a true value,
the token returned by this method will only be valid from the IP address which called this method.</a></dt>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>On success,
a hash containing two items,
<code class="code">id</code>,
the numeric id of the user that was logged in,
and a <code class="code">token</code> which can be passed in the parameters as authentication in other calls.
The token can be sent along with any future requests to the webservice,
for the duration of the session,
i.e.
till <a href="#logout" class="podlinkpod"
>User.logout</a> is called.</p>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<dl>
<dt><a name="300_(Invalid_Username_or_Password)"
>300 (Invalid Username or Password)</a></dt>
<dd>
<p>The username does not exist,
or the password is wrong.</p>
<dt><a name="301_(Login_Disabled)"
>301 (Login Disabled)</a></dt>
<dd>
<p>The ability to login with this account has been disabled.
A reason may be specified with the error.</p>
<dt><a name="305_(New_Password_Required)"
>305 (New Password Required)</a></dt>
<dd>
<p>The current password is correct,
but the user is asked to change their password.</p>
<dt><a name="50_(Param_Required)"
>50 (Param Required)</a></dt>
<dd>
<p>A login or password parameter was not provided.</p>
</dd>
</dl>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="remember_was_removed_in_Bugzilla_5.0_as_this_method_no_longer_creates_a_login_cookie."
><code class="code">remember</code> was removed in Bugzilla <b>5.0</b> as this method no longer creates a login cookie.</a></dt>
<dd>
<dt><a name="restrict_login_was_added_in_Bugzilla_5.0."
><code class="code">restrict_login</code> was added in Bugzilla <b>5.0</b>.</a></dt>
<dd>
<dt><a name="token_was_added_in_Bugzilla_4.4.3."
><code class="code">token</code> was added in Bugzilla <b>4.4.3</b>.</a></dt>
<dd>
<dt><a name="This_function_will_be_removed_in_the_release_after_Bugzilla_5.0,_in_favour_of_API_keys."
>This function will be removed in the release after Bugzilla 5.0,
in favour of API keys.</a></dt>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="logout"
>logout</a></h2>
<p><b>DEPRECATED</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Log out the user.
Does nothing if there is no user logged in.</p>
<dt><a name="Params_(none)"
><b>Params</b> (none)</a></dt>
<dd>
<dt><a name="Returns_(nothing)"
><b>Returns</b> (nothing)</a></dt>
<dd>
<dt><a name="Errors_(none)"
><b>Errors</b> (none)</a></dt>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="valid_login"
>valid_login</a></h2>
<p><b>DEPRECATED</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>This method will verify whether a client's cookies or current login token is still valid or have expired.
A valid username must be provided as well that matches.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<dl>
<dt><a name="login"
><code class="code">login</code></a></dt>
<dd>
<p>The login name that matches the provided cookies or token.</p>
<dt><a name="token"
><code class="code">token</code></a></dt>
<dd>
<p>(string) Persistent login token current being used for authentication (optional).
Cookies passed by client will be used before the token if both provided.</p>
</dd>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>Returns true/false depending on if the current cookies or token are valid for the provided username.</p>
<dt><a name="Errors_(none)"
><b>Errors</b> (none)</a></dt>
<dd>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Added_in_Bugzilla_5.0."
>Added in Bugzilla <b>5.0</b>.</a></dt>
<dd>
<dt><a name="This_function_will_be_removed_in_the_release_after_Bugzilla_5.0,_in_favour_of_API_keys."
>This function will be removed in the release after Bugzilla 5.0,
in favour of API keys.</a></dt>
</dl>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="Account_Creation_and_Modification"
>Account Creation and Modification</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="offer_account_by_email"
>offer_account_by_email</a></h2>
<p><b>STABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Sends an email to the user,
offering to create an account.
The user will have to click on a URL in the email,
and choose their password and real name.</p>
<p>This is the recommended way to create a Bugzilla account.</p>
<dt><a name="Param"
><b>Param</b></a></dt>
<dd>
<dl>
<dt><a name="email_(string)_-_the_email_to_send_the_offer_to."
><code class="code">email</code> (string) - the email to send the offer to.</a></dt>
</dl>
<dt><a name="Returns_(nothing)"
><b>Returns</b> (nothing)</a></dt>
<dd>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<dl>
<dt><a name="500_(Account_Already_Exists)"
>500 (Account Already Exists)</a></dt>
<dd>
<p>An account with that email address already exists in Bugzilla.</p>
<dt><a name="501_(Illegal_Email_Address)"
>501 (Illegal Email Address)</a></dt>
<dd>
<p>This Bugzilla does not allow you to create accounts with the format of email address you specified.
Account creation may be entirely disabled.</p>
</dd>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="create"
>create</a></h2>
<p><b>STABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Creates a user account directly in Bugzilla,
password and all.
Instead of this,
you should use <a href="#offer_account_by_email" class="podlinkpod"
>"offer_account_by_email"</a> when possible,
because that makes sure that the email address specified can actually receive an email.
This function does not check that.</p>
<p>You must be logged in and have the <code class="code">editusers</code> privilege in order to call this function.</p>
<dt><a name="REST"
><b>REST</b></a></dt>
<dd>
<p>POST /rest/user</p>
<p>The params to include in the POST body as well as the returned data format,
are the same as below.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<dl>
<dt><a name="email_(string)_-_The_email_address_for_the_new_user."
><code class="code">email</code> (string) - The email address for the new user.</a></dt>
<dd>
<dt><a name="full_name_(string)_Optional_-_The_user's_full_name._Will_be_set_to_empty_if_not_specified."
><code class="code">full_name</code> (string) <b>Optional</b> - The user's full name.
Will be set to empty if not specified.</a></dt>
<dd>
<dt><a
><code class="code">password</code> (string) <b>Optional</b> - The password for the new user account,
in plain text.
It will be stripped of leading and trailing whitespace.
If blank or not specified,
the newly created account will exist in Bugzilla,
but will not be allowed to log in using DB authentication until a password is set either by the user (through resetting their password) or by the administrator.</a></dt>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash containing one item,
<code class="code">id</code>,
the numeric id of the user that was created.</p>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<p>The same as <a href="#offer_account_by_email" class="podlinkpod"
>"offer_account_by_email"</a>.
If a password is specified,
the function may also throw:</p>
<dl>
<dt><a name="502_(Password_Too_Short)"
>502 (Password Too Short)</a></dt>
<dd>
<p>The password specified is too short.
(Usually,
this means the password is under three characters.)</p>
</dd>
</dl>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Error_503_(Password_Too_Long)_removed_in_Bugzilla_3.6."
>Error 503 (Password Too Long) removed in Bugzilla <b>3.6</b>.</a></dt>
<dd>
<dt><a name="REST_API_call_added_in_Bugzilla_5.0."
>REST API call added in Bugzilla <b>5.0</b>.</a></dt>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="update"
>update</a></h2>
<p><b>EXPERIMENTAL</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Updates user accounts in Bugzilla.</p>
<dt><a name="REST"
><b>REST</b></a></dt>
<dd>
<p>PUT /rest/user/<user_id_or_name></p>
<p>The params to include in the PUT body as well as the returned data format,
are the same as below.
The <code class="code">ids</code> and <code class="code">names</code> params are overridden as they are pulled from the URL path.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<dl>
<dt><a name="ids"
><code class="code">ids</code></a></dt>
<dd>
<p><code class="code">array</code> Contains ids of user to update.</p>
<dt><a name="names"
><code class="code">names</code></a></dt>
<dd>
<p><code class="code">array</code> Contains email/login of user to update.</p>
<dt><a name="full_name"
><code class="code">full_name</code></a></dt>
<dd>
<p><code class="code">string</code> The new name of the user.</p>
<dt><a name="email"
><code class="code">email</code></a></dt>
<dd>
<p><code class="code">string</code> The email of the user.
Note that email used to login to bugzilla.
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.)</p>
<dt><a name="password"
><code class="code">password</code></a></dt>
<dd>
<p><code class="code">string</code> The password of the user.</p>
<dt><a name="email_enabled"
><code class="code">email_enabled</code></a></dt>
<dd>
<p><code class="code">boolean</code> A boolean value to enable/disable sending bug-related mail to the user.</p>
<dt><a name="login_denied_text"
><code class="code">login_denied_text</code></a></dt>
<dd>
<p><code class="code">string</code> A text field that holds the reason for disabling a user from logging into bugzilla,
if empty then the user account is enabled otherwise it is disabled/closed.</p>
<dt><a name="groups"
><code class="code">groups</code></a></dt>
<dd>
<p><code class="code">hash</code> These specify the groups that this user is directly a member of.
To set these,
you should pass a hash as the value.
The hash may contain the following fields:</p>
<dl>
<dt><a name="add_An_array_of_ints_or_strings._The_group_ids_or_group_names_that_the_user_should_be_added_to."
><code class="code">add</code> An array of <code class="code">int</code>s or <code class="code">string</code>s.
The group ids or group names that the user should be added to.</a></dt>
<dd>
<dt><a name="remove_An_array_of_ints_or_strings._The_group_ids_or_group_names_that_the_user_should_be_removed_from."
><code class="code">remove</code> An array of <code class="code">int</code>s or <code class="code">string</code>s.
The group ids or group names that the user should be removed from.</a></dt>
<dd>
<dt><a
><code class="code">set</code> An array of <code class="code">int</code>s or <code class="code">string</code>s.
An exact set of group ids and group names that the user should be a member of.
NOTE: This does not remove groups from the user where the person making the change does not have the bless privilege for.</a></dt>
<dd>
<p>If you specify <code class="code">set</code>,
then <code class="code">add</code> and <code class="code">remove</code> will be ignored.
A group in both the <code class="code">add</code> and <code class="code">remove</code> list will be added.
Specifying a group that the user making the change does not have bless rights will generate an error.</p>
</dd>
</dl>
<dt><a name="bless_groups"
><code class="code">bless_groups</code></a></dt>
<dd>
<p><code class="code">hash</code> - This is the same as groups,
but affects what groups a user has direct membership to bless that group.
It takes the same inputs as groups.</p>
</dd>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A <code class="code">hash</code> with a single field "users".
This points to an array of hashes with the following fields:</p>
<dl>
<dt><a name="id"
><code class="code">id</code></a></dt>
<dd>
<p><code class="code">int</code> The id of the user that was updated.</p>
<dt><a name="changes"
><code class="code">changes</code></a></dt>
<dd>
<p><code class="code">hash</code> The changes that were actually done on this user.
The keys are the names of the fields that were changed,
and the values are a hash with two keys:</p>
<dl>
<dt><a name="added"
><code class="code">added</code></a></dt>
<dd>
<p><code class="code">string</code> The values that were added to this field,
possibly a comma-and-space-separated list if multiple values were added.</p>
<dt><a name="removed"
><code class="code">removed</code></a></dt>
<dd>
<p><code class="code">string</code> The values that were removed from this field,
possibly a comma-and-space-separated list if multiple values were removed.</p>
</dd>
</dl>
</dd>
</dl>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<dl>
<dt><a name="51_(Bad_Login_Name)"
>51 (Bad Login Name)</a></dt>
<dd>
<p>You passed an invalid login name in the "names" array.</p>
<dt><a name="304_(Authorization_Required)"
>304 (Authorization Required)</a></dt>
<dd>
<p>Logged-in users are not authorized to edit other users.</p>
</dd>
</dl>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="REST_API_call_added_in_Bugzilla_5.0."
>REST API call added in Bugzilla <b>5.0</b>.</a></dt>
</dl>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="User_Info"
>User Info</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="get"
>get</a></h2>
<p><b>STABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Gets information about user accounts in Bugzilla.</p>
<dt><a name="REST"
><b>REST</b></a></dt>
<dd>
<p>To get information about a single user:</p>
<p>GET /rest/user/<user_id_or_name></p>
<p>To search for users by name,
group using URL params same as below:</p>
<p>GET /rest/user</p>
<p>The returned data format is the same as below.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<p><b>Note</b>: At least one of <code class="code">ids</code>,
<code class="code">names</code>,
or <code class="code">match</code> must be specified.</p>
<p><b>Note</b>: Users will not be returned more than once,
so even if a user is matched by more than one argument,
only one user will be returned.</p>
<p>In addition to the parameters below,
this method also accepts the standard <a href="../../Bugzilla/WebService.html#include_fields" class="podlinkpod"
>include_fields</a> and <a href="../../Bugzilla/WebService.html#exclude_fields" class="podlinkpod"
>exclude_fields</a> arguments.</p>
<dl>
<dt><a name="ids_(array)"
><code class="code">ids</code> (array)</a></dt>
<dd>
<p>An array of integers,
representing user ids.</p>
<p>Logged-out users cannot pass this parameter to this function.
If they try,
they will get an error.
Logged-in users will get an error if they specify the id of a user they cannot see.</p>
<dt><a name="names_(array)"
><code class="code">names</code> (array)</a></dt>
<dd>
<p>An array of login names (strings).</p>
<dt><a name="match_(array)"
><code class="code">match</code> (array)</a></dt>
<dd>
<p>An array of strings.
This works just like "user matching" in Bugzilla itself.
Users will be returned whose real name or login name contains any one of the specified strings.
Users that you cannot see will not be included in the returned list.</p>
<p>Most installations have a limit on how many matches are returned for each string,
which defaults to 1000 but can be changed by the Bugzilla administrator.</p>
<p>Logged-out users cannot use this argument,
and an error will be thrown 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.)</p>
<dt><a name="limit_(int)"
><code class="code">limit</code> (int)</a></dt>
<dd>
<p>Limit the number of users matched by the <code class="code">match</code> parameter.
If value is greater than the system limit,
the system limit will be used.
This parameter is only used when user matching using the <code class="code">match</code> parameter is being performed.</p>
<dt><a name="group_ids_(array)"
><code class="code">group_ids</code> (array)</a></dt>
<dd>
<dt><a name="groups_(array)"
><code class="code">groups</code> (array)</a></dt>
<dd>
<p><code class="code">group_ids</code> is an array of numeric ids for groups that a user can be in.
<code class="code">groups</code> is an array of names of groups that a user can be in.
If these are specified,
they limit the return value to users who are in <i>any</i> of the groups specified.</p>
<dt><a name="include_disabled_(boolean)"
><code class="code">include_disabled</code> (boolean)</a></dt>
<dd>
<p>By default,
when using the <code class="code">match</code> parameter,
disabled users are excluded from the returned results unless their full username is identical to the match string.
Setting <code class="code">include_disabled</code> to <code class="code">true</code> will include disabled users in the returned results even if their username doesn't fully match the input string.</p>
</dd>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash containing one item,
<code class="code">users</code>,
that is an array of hashes.
Each hash describes a user,
and has the following items:</p>
<dl>
<dt><a name="id"
>id</a></dt>
<dd>
<p><code class="code">int</code> The unique integer ID that Bugzilla uses to represent this user.
Even if the user's login name changes,
this will not change.</p>
<dt><a name="real_name"
>real_name</a></dt>
<dd>
<p><code class="code">string</code> The actual name of the user.
May be blank.</p>
<dt><a name="email"
>email</a></dt>
<dd>
<p><code class="code">string</code> The email address of the user.</p>
<dt><a name="name"
>name</a></dt>
<dd>
<p><code class="code">string</code> The login name of the user.
Note that in some situations this is different than their email.</p>
<dt><a name="can_login"
>can_login</a></dt>
<dd>
<p><code class="code">boolean</code> A boolean value to indicate if the user can login into bugzilla.</p>
<dt><a name="email_enabled"
>email_enabled</a></dt>
<dd>
<p><code class="code">boolean</code> A boolean value to indicate if bug-related mail will be sent to the user or not.</p>
<dt><a name="login_denied_text"
>login_denied_text</a></dt>
<dd>
<p><code class="code">string</code> A text field that holds the reason for disabling a user from logging into bugzilla,
if empty then the user account is enabled.
Otherwise it is disabled/closed.</p>
<dt><a name="groups"
>groups</a></dt>
<dd>
<p><code class="code">array</code> An array of group hashes the user is a member of.
If the currently logged in user is querying their own account or is a member of the 'editusers' group,
the array will contain all the groups that the user is a member of.
Otherwise,
the array will only contain groups that the logged in user can bless.
Each hash describes the group and contains the following items:</p>
<dl>
<dt><a name="id"
>id</a></dt>
<dd>
<p><code class="code">int</code> The group id</p>
<dt><a name="name"
>name</a></dt>
<dd>
<p><code class="code">string</code> The name of the group</p>
<dt><a name="description"
>description</a></dt>
<dd>
<p><code class="code">string</code> The description for the group</p>
</dd>
</dl>
<dt><a name="saved_searches"
>saved_searches</a></dt>
<dd>
<p><code class="code">array</code> An array of hashes,
each of which represents a user's saved search and has the following keys:</p>
<dl>
<dt><a name="id"
>id</a></dt>
<dd>
<p><code class="code">int</code> An integer id uniquely identifying the saved search.</p>
<dt><a name="name"
>name</a></dt>
<dd>
<p><code class="code">string</code> The name of the saved search.</p>
<dt><a name="query"
>query</a></dt>
<dd>
<p><code class="code">string</code> The CGI parameters for the saved search.</p>
</dd>
</dl>
<dt><a name="saved_reports"
>saved_reports</a></dt>
<dd>
<p><code class="code">array</code> An array of hashes,
each of which represents a user's saved report and has the following keys:</p>
<dl>
<dt><a name="id"
>id</a></dt>
<dd>
<p><code class="code">int</code> An integer id uniquely identifying the saved report.</p>
<dt><a name="name"
>name</a></dt>
<dd>
<p><code class="code">string</code> The name of the saved report.</p>
<dt><a name="query"
>query</a></dt>
<dd>
<p><code class="code">string</code> The CGI parameters for the saved report.</p>
</dd>
</dl>
<p><b>Note</b>: If you are not logged in to Bugzilla when you call this function,
you will only be returned the <code class="code">id</code>,
<code class="code">name</code>,
and <code class="code">real_name</code> items.
If you are logged in and not in editusers group,
you will only be returned the <code class="code">id</code>,
<code class="code">name</code>,
<code class="code">real_name</code>,
<code class="code">email</code>,
<code class="code">can_login</code>,
and <code class="code">groups</code> items.
The groups returned are filtered based on your permission to bless each group.
The <code class="code">saved_searches</code> and <code class="code">saved_reports</code> items are only returned if you are querying your own account,
even if you are in the editusers group.</p>
</dd>
</dl>
<dt><a name="Errors"
><b>Errors</b></a></dt>
<dd>
<dl>
<dt><a name="51_(Bad_Login_Name_or_Group_ID)"
>51 (Bad Login Name or Group ID)</a></dt>
<dd>
<p>You passed an invalid login name in the "names" array or a bad group ID in the <code class="code">group_ids</code> argument.</p>
<dt><a name="52_(Invalid_Parameter)"
>52 (Invalid Parameter)</a></dt>
<dd>
<p>The value used must be an integer greater than zero.</p>
<dt><a name="304_(Authorization_Required)"
>304 (Authorization Required)</a></dt>
<dd>
<p>You are logged in,
but you are not authorized to see one of the users you wanted to get information about by user id.</p>
<dt><a name="505_(User_Access_By_Id_or_User-Matching_Denied)"
>505 (User Access By Id or User-Matching Denied)</a></dt>
<dd>
<p>Logged-out users cannot use the "ids" or "match" arguments to this function.</p>
<dt><a name="804_(Invalid_Group_Name)"
>804 (Invalid Group Name)</a></dt>
<dd>
<p>You passed a group name in the <code class="code">groups</code> argument which either does not exist or you do not belong to it.</p>
</dd>
</dl>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Added_in_Bugzilla_3.4."
>Added in Bugzilla <b>3.4</b>.</a></dt>
<dd>
<dt><a name="group_ids_and_groups_were_added_in_Bugzilla_4.0."
><code class="code">group_ids</code> and <code class="code">groups</code> were added in Bugzilla <b>4.0</b>.</a></dt>
<dd>
<dt><a name="include_disabled_was_added_in_Bugzilla_4.0._Default_behavior_for_match_was_changed_to_only_return_enabled_accounts."
><code class="code">include_disabled</code> was added in Bugzilla <b>4.0</b>.
Default behavior for <code class="code">match</code> was changed to only return enabled accounts.</a></dt>
<dd>
<dt><a name="Error_804_has_been_added_in_Bugzilla_4.0.9_and_4.2.4._It's_now_illegal_to_pass_a_group_name_you_don't_belong_to."
>Error 804 has been added in Bugzilla 4.0.9 and 4.2.4.
It's now illegal to pass a group name you don't belong to.</a></dt>
<dd>
<dt><a name="groups,_saved_searches,_and_saved_reports_were_added_in_Bugzilla_4.4."
><code class="code">groups</code>,
<code class="code">saved_searches</code>,
and <code class="code">saved_reports</code> were added in Bugzilla <b>4.4</b>.</a></dt>
<dd>
<dt><a name="REST_API_call_added_in_Bugzilla_5.0."
>REST API call added in Bugzilla <b>5.0</b>.</a></dt>
</dl>
</dd>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
