Users
*****
This part of the Bugzilla API allows you to create user accounts, get
information about user accounts and to log in or out using an existing
account.
Login
=====
Logging in with a username and password is required for many Bugzilla
installations, in order to search for private bugs, post new bugs,
etc. This method allows you to retrieve a token that can be used as
authentication for subsequent API calls. Otherwise yuou will need to
pass your "login" and "password" with each call.
This method will be going away in the future in favor of using *API
keys*.
**Request**
GET /rest/login?login=foo@example.com&password=toosecrettoshow
+----------------+---------+----------------------------------------------------------+
| name | type | description |
+================+=========+==========================================================+
| **login** | string | The user's login name. |
+----------------+---------+----------------------------------------------------------+
| **password** | string | The user's password. |
+----------------+---------+----------------------------------------------------------+
| restrict_login | boolean | If set to a true value, the token returned by this |
| | | method will only be valid from the IP address which |
| | | called this method. |
+----------------+---------+----------------------------------------------------------+
**Response**
{
"token": "786-OLaWfBisMY",
"id": 786
}
+----------+--------+-----------------------------------------------------------------+
| name | type | description |
+==========+========+=================================================================+
| id | int | Numeric ID of the user that was logged in. |
+----------+--------+-----------------------------------------------------------------+
| token | string | Token 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. til Logout is called. |
+----------+--------+-----------------------------------------------------------------+
Logout
======
Log out the user. Basically it invalidates the token provided so it
cannot be re-used. Does nothing if the token is not in use. Will also
clear any existing authentication cookies the client may still have
stored.
**Request**
GET /rest/logout?token=1234-VWvO51X69r
+-------+--------+-----------------------------------------------------+
| name | type | description |
+=======+========+=====================================================+
| token | string | The user's token used for authentication. |
+-------+--------+-----------------------------------------------------+
Valid Login
===========
This method will verify whether a client's cookies or current login
token is still valid or have expired. A valid username that matches
must be provided as well.
**Request**
GET /rest/valid_login?login=foo@example.com&token=1234-VWvO51X69r
+-----------+---------+---------------------------------------------------------------+
| name | type | description |
+===========+=========+===============================================================+
| **login** | string | The login name that matches the provided cookies or token. |
+-----------+---------+---------------------------------------------------------------+
| token | string | Persistent login token currently being used for |
| | | authentication. |
+-----------+---------+---------------------------------------------------------------+
**Response**
Returns true/false depending on if the current token is valid for the
provided username.
Create User
===========
Creates a user account directly in Bugzilla, password and all. Instead
of this, you should use **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
authenticated and be in the *editusers* group to perform this action.
**Request**
POST /rest/user
{
"email" : "user@bugzilla.org",
"full_name" : "Test User",
"password" : "K16ldRr922I1"
}
+------------+--------+---------------------------------------------------------------+
| name | type | description |
+============+========+===============================================================+
| **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 will |
| | | be stripped of leading and trailing whitespace. If blank or |
| | | not specified, the new 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. |
+------------+--------+---------------------------------------------------------------+
**Response**
{
"id": 58707
}
+------+------+----------------------------------------------+
| name | type | desciption |
+======+======+==============================================+
| id | int | The numeric ID of the user that was created. |
+------+------+----------------------------------------------+
Update User
===========
Updates an existing user account in Bugzilla. You must be
authenticated and be in the *editusers* group to perform this action.
**Request**
PUT /rest/user/(id_or_name)
You can edit a single user by passing the ID or login name of the user
in the URL. To edit more than one user, you can specify addition IDs
or login names using the "ids" or "names" parameters respectively.
+-------------------+---------+-------------------------------------------------------+
| name | type | description |
+===================+=========+=======================================================+
| **id_or_name** | mixed | Either the ID or the login name of the user to |
| | | update. |
+-------------------+---------+-------------------------------------------------------+
| **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 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.) |
+-------------------+---------+-------------------------------------------------------+
| password | string | The password of the user. |
+-------------------+---------+-------------------------------------------------------+
| email_enabled | boolean | A boolean value to enable/disable sending bug-related |
| | | mail to the user. |
+-------------------+---------+-------------------------------------------------------+
| login_denied_text | string | 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. |
+-------------------+---------+-------------------------------------------------------+
| groups | object | These specify the groups that this user is directly a |
| | | member of. To set these, you should pass an object as |
| | | the value. The object's items are described in the |
| | | Groups update objects below. |
+-------------------+---------+-------------------------------------------------------+
| bless_groups | object | 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. |
+-------------------+---------+-------------------------------------------------------+
Groups and bless groups update object:
+--------+-------+--------------------------------------------------------------------+
| name | type | description |
+========+=======+====================================================================+
| add | array | The group IDs or group names that the user should be added to. |
+--------+-------+--------------------------------------------------------------------+
| remove | array | The group IDs or group names that the user should be removed from. |
+--------+-------+--------------------------------------------------------------------+
| set | array | Integers or strings which are an exact set of group IDs and group |
| | | names that the user should be a member of. This does not remove |
| | | groups from the user when the person making the change does not |
| | | have the bless privilege for the group. |
+--------+-------+--------------------------------------------------------------------+
If you specify "set", then "add" and "remove" will be ignored. A group
in both the "add" and "remove" list will be added. Specifying a group
that the user making the change does not have bless rights will
generate an error.
**Response**
* users: (array) List of user change objects with the following
items:
+---------+--------+------------------------------------------------------------------+
| name | type | description |
+=========+========+==================================================================+
| id | int | The ID of the user that was updated. |
+---------+--------+------------------------------------------------------------------+
| changes | object | The changes that were actually done on this user. The keys are |
| | | the names of the fields that were changed, and the values are an |
| | | object with two items: * added: (string) The values that were |
| | | added to this field, possibly a comma-and-space-separated list |
| | | if multiple values were added. * removed: (string) The values |
| | | that were removed from this field, possibly a comma-and-space- |
| | | separated list if multiple values were removed. |
+---------+--------+------------------------------------------------------------------+
Get User
========
Gets information about user accounts in Bugzilla.
**Request**
To get information about a single user in Bugzilla:
GET /rest/user/(id_or_name)
To get multiple users by name or ID:
GET /rest/user?names=foo@bar.com&name=test@bugzilla.org
GET /rest/user?ids=123&ids=321
To get user matching a search string:
GET /rest/user?match=foo
To get user by using an integer ID value or by using "match", you must
be authenticated.
+------------------+---------+--------------------------------------------------------+
| name | type | description |
+==================+=========+========================================================+
| id_or_name | mixed | An integer user ID or login name of the user. |
+------------------+---------+--------------------------------------------------------+
| ids | array | Integer user IDs. 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. |
+------------------+---------+--------------------------------------------------------+
| names | array | Login names. |
+------------------+---------+--------------------------------------------------------+
| match | array | 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. Most installations have a limit on how |
| | | many matches are returned for each string; the default |
| | | is 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. |
| | | (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.) |
+------------------+---------+--------------------------------------------------------+
| limit | int | Limit the number of users matched by the "match" |
| | | parameter. If the value is greater than the system |
| | | limit, the system limit will be used. This parameter |
| | | is only valid when using the "match" parameter. |
+------------------+---------+--------------------------------------------------------+
| group_ids | array | Numeric IDs for groups that a user can be in. |
+------------------+---------+--------------------------------------------------------+
| groups | array | Names of groups that a user can be in. If "group_ids" |
| | | or "groups" are specified, they limit the return value |
| | | to users who are in *any* of the groups specified. |
+------------------+---------+--------------------------------------------------------+
| include_disabled | boolean | By default, when using the "match" parameter, disabled |
| | | users are excluded from the returned results unless |
| | | their full username is identical to the match string. |
| | | Setting "include_disabled" to "true" will include |
| | | disabled users in the returned results even if their |
| | | username doesn't fully match the input string. |
+------------------+---------+--------------------------------------------------------+
**Response**
* users: (array) Each object describes a user and has the following
items:
+-------------------+---------+-------------------------------------------------------+
| name | type | description |
+===================+=========+=======================================================+
| id | int | The unique integer ID that Bugzilla uses to represent |
| | | this user. Even if the user's login name changes, |
| | | 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. |
+-------------------+---------+-------------------------------------------------------+
| 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 |
| | | be sent to the user or not. |
+-------------------+---------+-------------------------------------------------------+
| login_denied_text | string | 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. |
+-------------------+---------+-------------------------------------------------------+
| groups | array | Groups 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 object describes |
| | | the group and contains the items described in the |
| | | Group object below. |
+-------------------+---------+-------------------------------------------------------+
| saved_searches | array | User's saved searches, each having the following |
| | | Search object items described below. |
+-------------------+---------+-------------------------------------------------------+
| saved_reports | array | User's saved reports, each having the following |
| | | Search object items described below. |
+-------------------+---------+-------------------------------------------------------+
Group object:
+-------------+--------+--------------------------------------------------------------+
| name | type | description |
+=============+========+==============================================================+
| id | int | The group ID |
+-------------+--------+--------------------------------------------------------------+
| name | string | The name of the group |
+-------------+--------+--------------------------------------------------------------+
| description | string | The description for the group |
+-------------+--------+--------------------------------------------------------------+
Search object:
+-------+--------+--------------------------------------------------------------------+
| name | type | description |
+=======+========+====================================================================+
| id | int | An integer ID uniquely identifying the saved report. |
+-------+--------+--------------------------------------------------------------------+
| name | string | The name of the saved report. |
+-------+--------+--------------------------------------------------------------------+
| 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 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.
======================================================================
This documentation undoubtedly has bugs; if you find some, please file
them here.
