Patch Group

Description

Partially updates an existing AttackForge Group. This is a write operation: it updates the group's own details, settings and custom fields. Only the keys supplied in args are changed; omitted keys are left untouched, and at least one key other than group_id must be supplied.

The shape of args is declared inline (see Building args for Write Tools), so no preparatory call is needed.

This tool does not change which projects the group is linked to - use patch_project_groups for that - and does not archive or restore the group - use archive_group and restore_group.

Preconditions: the caller must be an administrator, and the group must exist and not be archived. On success the patched group id is returned.

How To Enable

1. Go to Users

2. Select the user you would like to provide access to this tool

3. Click on Access > MCP

4. Click on Add Tools

5. Select the tool patch_group and click Add

Example Prompts

• Rename the Red Team group to Offensive Security.

• Make Bob Jones the primary contact for the ACME group.

• Turn off project team notifications for the Contractors group.

• Share project requests created by members of the SOC group with the group automatically.

• Update the region custom field on the Red Team group to "APAC".

Parameters

Parameter	Type	Required	Description
args	object	Yes	The group-patch payload - see the keys below.

args keys:

Key	Type	Required	Description
group_id	string	Yes	Id (24-hex) of the group to patch. Source: find_groups. An archived group cannot be patched.
name	string	No	The group name. Names are not unique.
owner	string	No	Free-text owner recorded on the group, such as a team or business unit. It is a label only and grants nobody access.
primary_contact_email	string	No	Email address of the group's primary contact. It is recorded only; nothing is sent to it.
primary_contact_name	string	No	Name of the group's primary contact.
primary_contact_number	string	No	Phone number of the group's primary contact.
auto_add_project_request	boolean	No	Whether a project request created by a member of the group is automatically shared with the group.
enable_project_team_notifications	boolean	No	Whether the group's members receive the project team notification emails of the projects the group is linked to.
custom_fields	array	No	Custom field values, each { key, value }. Supplying a custom field replaces its current value; supplying null clears it. Discover keys via get_field_structure(model="group"). Keys that are not in the configured field structure, or that are configured with edit access, are accepted.

A call that supplies only group_id is refused with No fields to patch were supplied.

Example Response

{
  "group_id": "65b1f0a28cade68ca7bc71a4"
}