<<

# Bugzilla::Webservice::User

- NAME
- DESCRIPTION
- METHODS
  - 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.

# METHODS

See Bugzilla::WebService for a description of what STABLE, UNSTABLE, and EXPERIMENTAL mean, and for more information about error codes.

## Account Creation

`offer_account_by_email` EXPERIMENTAL

  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.

  Params: `email` - The email to send the offer to.

  Returns: nothing

  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.

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

<<