5.7.92. Bugzilla::WebService::Group

5.7.92.1. NAME

Bugzilla::Webservice::Group - The API for creating, changing, and getting information about Groups.

5.7.92.2. DESCRIPTION

This part of the Bugzilla API allows you to create Groups and get information about them.

5.7.92.3. METHODS

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

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.

5.7.92.4. Group Creation and Modification

create

UNSTABLE

Description

This allows you to create a new group in Bugzilla.

REST

POST /rest/group

The params to include in the POST body as well as the returned data format, are the same as below.

Params

Some params must be set, or an error will be thrown. These params are marked Required.

name

Required string A short name for this group. Must be unique. This is not usually displayed in the user interface, except in a few places.

description

Required string A human-readable name for this group. Should be relatively short. This is what will normally appear in the UI as the name of the group.

user_regexp

string A regular expression. Any user whose Bugzilla username matches this regular expression will automatically be granted membership in this group.

is_active

boolean True if new group can be used for bugs, False if this is a group that will only contain users and no bugs will be restricted to it.

icon_url

string A URL pointing to a small icon used to identify the group. This icon will show up next to users' names in various parts of Bugzilla if they are in this group.

Returns

A hash with one element, id. This is the id of the newly-created group.

Errors

800 (Empty Group Name)

You must specify a value for the name field.

801 (Group Exists)

There is already another group with the same name.

802 (Group Missing Description)

You must specify a value for the description field.

803 (Group Regexp Invalid)

You specified an invalid regular expression in the user_regexp field.

History

REST API call added in Bugzilla 5.0.

update

UNSTABLE

Description

This allows you to update a group in Bugzilla.

REST

PUT /rest/group/<group_name_or_id>

The params to include in the PUT body as well as the returned data format, are the same as below. The ids param will be overridden as it is pulled from the URL path.

Params

At least ids or names must be set, or an error will be thrown.

ids

Required array Contain ids of groups to update.

names

Required array Contain names of groups to update.

name

string A new name for group.

description

string A new description for groups. This is what will appear in the UI as the name of the groups.

user_regexp

string A new regular expression for email. Will automatically grant membership to these groups to anyone with an email address that matches this perl regular expression.

is_active

boolean Set if groups are active and eligible to be used for bugs. True if bugs can be restricted to this group, false otherwise.

icon_url

string A URL pointing to an icon that will appear next to the name of users who are in this group.

Returns

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

id

int The id of the group that was updated.

changes

hash The changes that were actually done on this group. 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

The same as create.

History

REST API call added in Bugzilla 5.0.

5.7.92.5. Group Information

get

UNSTABLE

Description

Returns information about Bugzilla::Group|Groups.

REST

To return information about a specific group by id or name:

GET /rest/group/<group_id_or_name>

You can also return information about more than one specific group by using the following in your query string:

GET /rest/group?ids=1&ids=2&ids=3 or GET /group?names=ProductOne&names=Product2

the returned data format is same as below.

Params

If neither ids or names is passed, and you are in the creategroups or editusers group, then all groups will be retrieved. Otherwise, only groups that you have bless privileges for will be returned.

ids

array Contain ids of groups to update.

names

array Contain names of groups to update.

membership

boolean Set to 1 then a list of members of the passed groups' names and ids will be returned.

Returns

If the user is a member of the "creategroups" group they will receive information about all groups or groups matching the criteria that they passed. You have to be in the creategroups group unless you're requesting membership information.

If the user is not a member of the "creategroups" group, but they are in the "editusers" group or have bless privileges to the groups they require membership information for, the is_active, is_bug_group and user_regexp values are not supplied.

The return value will be a hash containing group names as the keys, each group name will point to a hash that describes the group and has the following items:

id

int The unique integer ID that Bugzilla uses to identify this group. Even if the name of the group changes, this ID will stay the same.

name

string The name of the group.

description

string The description of the group.

is_bug_group

int Whether this groups is to be used for bug reports or is only administrative specific.

user_regexp

string A regular expression that allows users to be added to this group if their login matches.

is_active

int Whether this group is currently active or not.

users

array An array of hashes, each hash contains a user object for one of the members of this group, only returned if the user sets the membershipparameter to 1, the user hash has the following items:

id

int The id of the user.

real_name

string The actual name of the user.

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.

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

Errors

51 (Invalid Object)

A non existing group name was passed to the function, as a result no group object existed for that invalid name.

805 (Cannot view groups)

Logged-in users are not authorized to edit bugzilla groups as they are not members of the creategroups group in bugzilla, or they are not authorized to access group member's information as they are not members of the "editusers" group or can bless the group.

History

This function was added in Bugzilla 5.0.

---

This documentation undoubtedly has bugs; if you find some, please file them here.