Restore Group
Description
Restores an AttackForge Group that was previously archived by archive_group. This is a write operation: the group reappears in the normal group listings and, because archiving left its members, member admins, project links and project request links in place, gives its members their access back.
The shape of args is declared inline (see Building args for Write Tools), so no preparatory call is needed. Archived groups are hidden from find_groups unless include_archived is set, so use that to find the id to restore.
Preconditions: the caller must be an administrator, and the tenant must be within its group licence. On success the group id is returned together with an updated flag.
How To Enable
Go to
UsersSelect the user you would like to provide access to this tool
Click on
Access > MCPClick on
Add ToolsSelect the tool
restore_groupand clickAdd
Example Prompts
Restore the Contractors group.
The ACME engagement has restarted - bring its group back.
Which groups are archived? Restore the one called Red Team.
Parameters
args
object
Yes
The group-restore payload - see the keys below.
args keys:
group_id
string
Yes
Id (24-hex) of the archived group to restore. Source: find_groups called with include_archived set to true, since an archived group is otherwise hidden from it.
updatedistruewhen the group was actually restored by this call.falsemeans the call succeeded but changed nothing because the group was not archived in the first place - it is not an error and the call should not be retried.
Example Response
Last updated