Archive Group

Description

Archives an existing AttackForge Group. This is a write operation, and a soft delete: the group record is kept, but the group stops appearing in the normal group listings, stops giving its members access through its links, and frees its place in the tenant's group licence. Its members, member admins, project links and project request links are left as they are, so restore_group brings the group back as it was.

The shape of args is declared inline (see Building args for Write Tools), so no preparatory call is needed. An archived group is hidden from find_groups and count_groups unless an administrator sets include_archived, and cannot be patched until it is restored.

Preconditions: the caller must be an administrator. On success the group id is returned together with an updated flag.

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 archive_group and click Add

Example Prompts

• Archive the Contractors group.

• The ACME engagement is over - archive its group.

• We have hit the group licence limit. Archive the groups nobody uses any more.

Parameters

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

args keys:

Key	Type	Required	Description
group_id	string	Yes	Id (24-hex) of the group to archive. Source: find_groups.

updated is true when the group was actually archived by this call. false means the call succeeded but changed nothing because the group was already archived - it is not an error and the call should not be retried.

Example Response

{
  "group_id": "65b1f0a28cade68ca7bc71a4",
  "updated": true
}