BZ::Cl...::Group(3pm)

📦
version 4.9100 · 4 versions
, in epel 10

💅 BZ::Cl...::Group(3pm) — like, the whole manual, but make it make sense

okay so first things first, bestie: this is a User Contributed Perl Documentation page, section 3pm, and the module's full name is BZ::Cl...::Group (yes the man page really does abbreviate it like that, we don't question the ancestors 💀).

🌸 NAME

BZ::Client::Group — the API for creating, changing, and getting info on Groups ✨

🎀 VERSION

version 4.91

🦋 SYNOPSIS

ok so this class is your whole group-chat admin toolkit — it gives you methods for accessing and managing Groups in Bugzilla 🫶

 my $client = BZ::Client->new( url       => $url,
                               user      => $user,
                               password  => $password );

 my $id = BZ::Client::Group->create( $client, \%params );

like, you spin up a client, you pass it your creds, and then boom — you're creating groups. iconic behavior tbh.

👑 CLASS METHODS

this section lists the class methods, which are available in this module. let's go 🔥

⭐ create

 $id = BZ::Client::Group->create( $client, \%params );

This allows you to create a new Group in Bugzilla. brand new group, fresh out the wrapper 🍓

💀 History

Marked as unstable as of Bugzilla 5.0. (yes bestie, unstable — proceed with the awareness of it all 🙈)

🌈 Parameters

Some params must be set, or an error will be thrown. These params are noted as Required. no skipping, fr fr.

  • name — name (string) A short name for this group. Must be unique.

This is infrequently displayed in the web user interface. (like, it exists, it's just not the main character in the UI 💅)

Required.

  • description — description (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. ✨ this one's the icon.

Required.

  • user_regexp — user_regexp (string) A regular expression. Any user whose Bugzilla username matches this regular expression will automatically be granted membership in this group. (automatic membership, no cap 🫶)
  • is_active — 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 — icon_url (boolean) 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. 🎀 cute little badge energy.

🦋 Returns

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.

🧚 update

 $id = BZ::Client::Group->update( $client, \%params );

This allows you to update a Group in Bugzilla. glow-up time 💅

💀 History

As of Bugzilla 5.0. this is marked as unstable. (that sentence really does end with a period and then a new clause, and we're keeping it exactly as the ancestors wrote it, periodt.)

💜 Parameters

Either ids or names is required to select the bugs you want to update.

All other values change or set something in the product.

  • ids — ids (array) Numeric ID's of the groups you wish to update.
  • names — names (array) Text names of the groups that you wish to update.
  • name — name (string) A new name for group.
  • description — description (string) A new description for groups. This is what will appear in the UI as the name of the groups.
  • user_regexp — 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 — 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 — icon_url (string) A URL pointing to an icon that will appear next to the name of users who are in this group. 🖼️

🌸 Returns

An array or arrayref of hashes containing the following:

  • id — id (int) The ID of the Group that was updated.
  • changes — 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 — added (string) The values that were added to this field, possibly a comma-and-space-separated list if multiple values were added.
    • removed — removed (string) The values that were removed from this field, possibly a comma-and-space-separated list if multiple values were removed.
Note that booleans will be represented with the strings 1 and <0>. (yes, <0>, brackets and all — that's not a typo, that's just what it says, don't come for me 😭)

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

🌈 get

Returns information about Bugzilla::Group. like a vibe check but for a group 🔍

⭐ History

This function was added in Bugzilla 5.0.

🦋 Parameters

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 — ids (array) Contain IDs of groups to update.
  • names — names (array) Contain names of groups to update.
  • membership — membership (boolean) Set to 1 then a list of members of the passed groups' names and IDs will be returned. (the roster reveal 👀)

💜 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. (so like, you get the group but not its whole personality 📵)

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 — 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. (the ID is the only thing that's truly loyal 💖)
  • name — name (string) The name of the group.
  • description — description (string) The description of the group.
  • is_bug_group — is_bug_group (int) Whether this groups is to be used for bug reports or is only administrative specific.
  • user_regexp — user_regexp (string) A regular expression that allows users to be added to this group if their login matches.
  • is_active — is_active (int) Whether this group is currently active or not.
  • users — 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 membership parameter to 1, the user hash has the following items:
    • id — id (int) The ID of the user.
    • real_name — real_name (string) The actual name of the user.
    • email — emaiL (string) The email address of the user. (yes it's spelled emaiL in the source, capital L and all — we love a quirky key name 😭)
    • name — name (string) The login name of the user. Note that in some situations this is different than their email.
    • can_login — can_login (boolean) A boolean value to indicate if the user can login into bugzilla.
    • email_enabled — email_enabled (boolean) A boolean value to indicate if bug-related mail will be sent to the user or not.
    • disabled_text — 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.

🙈 INSTANCE METHODS

FIXME Not yet implemented 💀

like... they left a FIXME in the published docs. honestly? relatable. but also: not there yet, bestie.

😭 EXCEPTION HANDLING

See BZ::Client::Exception — that's where the feelings (and the errors) get handled 🫶

⭐ SEE ALSO

💖 AUTHORS

  • Dean Hamstead <dean@bytefoundry.com.au>
  • Jochen Wiedmann <jochen.wiedmann@gmail.com>

This software is copyright (c) 2026 by Dean Hamstad.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. 🫶

and that's the whole page, bestie — written by the perl v5.40.2 girlies on 2026-07-16, archived forever in the BZ::Cl...::Group(3pm) section of the manual. go forth and manage your groups 💅✨🎀

📦 where this page comes from