5.7.245. Bugzilla::Extension::Workflows::WebService::GroupInvite¶

5.7.245.1. NAME¶

Bugzilla::Extension::Workflows::WebService::GroupInvite

5.7.245.2. DESCRIPTION¶

This part of the Bugzilla API allows you to invite users to groups and teams.

5.7.245.3. METHODS¶

invite_users¶

Invite users to groups and teams.

Params¶

groups:: An array of strings. The names of the groups and teams to add users to.
users:: An array of strings. The names of the users to affect.

Returns¶

Returns an array of hashes, one per user changed, with the following fields:

groups:: array An array of strings. If the user was added directly to any groups they will be listed here.
teams:: array An array of strings. If the user was added to any teams they will be listed here.
bug:: hash If a Group Membership Workflow bugs was created it will be detailed here.

Examples¶

JSONRPC call¶

{
    "jsonrpc": "2.0",
    "method": "GroupInvite.invite_users",
    "id": 1,
    "params": [
      {
        "users": ["fu@example.com", "bar@example.com"],
        "groups": ["TheBigGroup", "TheLittleGroup", "A-Team"]
      }
    ]
}

JSONRPC reply¶

{
    "id": 1,
    "error": null,
    "result": [
      "fu@example.com":  {
          "groups": ["TheLittleGroup"],
          "teams": ["A-Team"],
          "bug": {
            "id": 111,
            "summary": "bz_NEW bz_unspecified bz_unspecified bz_secure bz_requested",
            "bug_classes": ""Group membership request for fu@example.com"
          }
        },
       "bar@example.com": {
          "groups": ["TheLittleGroup"],
          "teams": ["A-Team"],
          "bug": {
            "id": 112,
            "summary": ""Group membership request for bar@example.com",
            "bug_classes": "bz_NEW bz_unspecified bz_unspecified bz_secure bz_requested"
          }
        }
    ]
}

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