<<

# Bugzilla::Webservice::User

- NAME
- DESCRIPTION
- METHODS
  - Logging In and Out
  - Account Creation

# 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.
    `remember` (bool) Optional - if the cookies returned by the call to login should expire with the session or not. In order for this option to have effect the Bugzilla server must be configured to allow the user to set this option - the Bugzilla parameter rememberlogin must be set to "defaulton" or "defaultoff". Addionally, the client application must implement management of cookies across sessions.
  Returns

    On success, a hash containing one item, `id`, the numeric id of the user that was logged in. A set of http cookies is also sent with the response. These cookies must be sent along with any future requests to the webservice, for the duration of the session.

  Errors
    300 (Invalid Username or Password)

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

    301 (Account Disabled)

      The account has been disabled. A reason may be specified with the error.

    50 (Param Required)

      A login or password parameter was not provided.

`logout`

  STABLE

  Description

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

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

## Account Creation

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

    501 (Account Already Exists)

      An account with that email address already exists in Bugzilla.

`create`

  EXPERIMENTAL

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

    503 (Password Too Long)

      The password specified is too long. (Usually, this means the password is over ten characters.)

  History
    Added in Bugzilla 3.4.

<<