<<

# Bugzilla::Webservice::User

- NAME
- DESCRIPTION
- METHODS
- Logging In and Out
  - login
  - logout
- Account Creation and Modification
  - offer_account_by_email
  - create
  - update
- User Info
  - get

# NAME

Bugzilla::Webservice::User - The User Account and Login API

# DESCRIPTION

This part of the Bugzilla API allows you to create User Accounts and log in/out using an existing account.

# METHODS

See Bugzilla::WebService for a description of how parameters are passed, and what STABLE, UNSTABLE, and EXPERIMENTAL mean.

# Logging In and Out

## login

STABLE

Description

  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.

Params
  `login` (string) - The user's login name.
  `password` (string) - The user's password.
  `restrict_login` (bool) Optional - If set to a true value, the token returned by this method will only be valid from the IP address which called this method.
Returns

  On success, a hash containing two items, `id`, the numeric id of the user that was logged in, and a `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. till User.logout is called.

Errors
  300 (Invalid Username or Password)

    The username does not exist, or the password is wrong.

  301 (Login Disabled)

    The ability to login with this account has been disabled. A reason may be specified with the error.

  305 (New Password Required)

    The current password is correct, but the user is asked to change his password.

  50 (Param Required)

    A login or password parameter was not provided.

History
  `remember` was removed in Bugzilla 4.4 as this method no longer creates a login cookie.
  `restrict_login` was added in Bugzilla 4.4.
  `token` was added in Bugzilla 4.4.

## logout

STABLE

Description

  Log out the user. Does nothing if there is no user logged in.

Params (none)
Returns (nothing)
Errors (none)

# Account Creation and Modification

## offer_account_by_email

STABLE

Description

  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.

  This is the recommended way to create a Bugzilla account.

Param
  `email` (string) - the email to send the offer to.
Returns (nothing)
Errors
  500 (Account Already Exists)

    An account with that email address already exists in Bugzilla.

  501 (Illegal Email Address)

    This Bugzilla does not allow you to create accounts with the format of email address you specified. Account creation may be entirely disabled.

## create

STABLE

Description

  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 logged in and have the `editusers` privilege in order to call this function.

Params
  `email` (string) - The email address for the new user.
  `full_name` (string) Optional - The user's full name. Will be set to empty if not specified.
  `password` (string) Optional - 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.
Returns

  A hash containing one item, `id`, the numeric id of the user that was created.

Errors

  The same as "offer_account_by_email". If a password is specified, the function may also throw:

  502 (Password Too Short)

    The password specified is too short. (Usually, this means the password is under three characters.)

History
  Error 503 (Password Too Long) removed in Bugzilla 3.6.

## update

EXPERIMENTAL

Description

  Updates user accounts in Bugzilla.

Params
  `ids`

    `array` Contains ids of user to update.

  `names`

    `array` Contains email/login of user 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.

Returns

  A `hash` with a single field "users". This points to an array of hashes with the following fields:

  `id`

    `int` The id of the user that was updated.

  `changes`

    `hash` 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:

    `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.

Errors
  51 (Bad Login Name)

    You passed an invalid login name in the "names" array.

  304 (Authorization Required)

    Logged-in users are not authorized to edit other users.

# User Info

## get

STABLE

Description

  Gets information about user accounts in Bugzilla.

Params

  Note: At least one of `ids`, `names`, or `match` must be specified.

  Note: 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.

  In addition to the parameters below, this method also accepts the standard include_fields and exclude_fields arguments.

  `ids` (array)

    An array of integers, representing 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)

    An array of login names (strings).

  `match` (array)

    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.

    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.

    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 value is greater than the system limit, the system limit will be used. This parameter is only used when user matching using the `match` parameter is being performed.

  `group_ids` (array)
  `groups` (array)

    `group_ids` is an array of numeric ids for groups that a user can be in. `groups` 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 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.

Returns

  A hash containing one item, `users`, that is an array of hashes. Each hash describes a user, and has the following items:

  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` An array of group hashes the user is a member of. If the currently logged in user is querying his 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:

    id

      `int` The group id

    name

      `string` The name of the group

    description

      `string` The description for the group

  saved_searches

    `array` An array of hashes, each of which represents a user's saved search and has the following keys:

    id

      `int` An integer id uniquely identifying the saved search.

    name

      `string` The name of the saved search.

    query

      `string` The CGI parameters for the saved search.

  saved_reports

    `array` An array of hashes, each of which represents a user's saved report and has the following keys:

    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.

    Note: If you are not logged in to Bugzilla when you call this function, you will only be returned the `id`, `name`, and `real_name` items. If you are logged in 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.

Errors
  51 (Bad Login Name or Group ID)

    You passed an invalid login name in the "names" array or a bad group ID in the `group_ids` argument.

  52 (Invalid Parameter)

    The value used must be an integer greater then zero.

  304 (Authorization Required)

    You are logged in, but you are not authorized to see one of the users you wanted to get information about by user id.

  505 (User Access By Id or User-Matching Denied)

    Logged-out users cannot use the "ids" or "match" arguments to this function.

  804 (Invalid Group Name)

    You passed a group name in the `groups` argument which either does not exist or you do not belong to it.

History
  Added in Bugzilla 3.4.
  `group_ids` and `groups` were added in Bugzilla 4.0.
  `include_disabled` was added in Bugzilla 4.0. Default behavior for `match` was changed to only return enabled accounts.
  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.
  `groups`, `saved_searches`, and `saved_reports` were added in Bugzilla 4.4.

<<